Skip to main content

A Model Context Protocol (MCP) server for Port.io

Project description

Port MCP Server

A Model Context Protocol (MCP) server for the Port.io API, enabling Claude to interact with Port.io's developer platform capabilities.

Installation

Obtain your Port credentials

  1. Create a Port.io Account:

    • Visit Port.io
    • Sign up for an account if you don't have one
  2. Create an API Key:

    • Navigate to your Port.io dashboard
    • Go to Settings > Credentials
    • Save both the Client ID and Client Secret

Claude Desktop

Add the following to your claude_desktop_config.json:

{
  "mcpServers": {
    "port": {
      "command": "uvx",
      "args": [
        "mcp-server-port@0.1.4",
        "--client-id", "YOUR_CLIENT_ID",
        "--client-secret", "YOUR_CLIENT_SECRET",
        "--region", "REGION" # US or EU
      ]
    }
  }
} 

Cursor

  1. Make sure uvx is installed:
pip install uvx
  1. Get its location:
which uvx
# Example output: /Users/janedoe/.local/bin/uvx
  1. Create a script to run the server:
# run-port-mcp.sh

cd /Users/janedoe/.local/bin/uvx

# Run the server with the specified credentials
./.venv/bin/uvx mcp-server-port@0.1.4 --client-id YOUR_CLIENT_ID --client-secret YOUR_CLIENT_SECRET --region YOUR_REGION
  1. Make it executable:
chmod +x /path/to/your/file/run-port-mcp.sh
  1. Configure in Cursor settings:
    • Go to Cursor settings > MCP Servers
    • Configure with:
      • Name - Port
      • Type - Command
      • Command - /path/to/your/file/run-port-mcp.sh

Cursor MCP Screenshot

Capabilities

Agent Tools

  1. trigger_port_agent
    • Trigger the Port.io AI agent with a prompt and wait for completion
    • Required inputs:
      • prompt (string): The prompt to send to the Port.io AI agent
    • Returns: Agent response with status, output, and any required actions
    • Note: The agent may return action URLs for bug reports or other tasks that require user interaction

Blueprint Tools

  1. get_blueprints

    • Retrieve a list of all blueprints from Port
    • Optional inputs:
      • detailed (boolean, default: false): Return complete schema details for each blueprint
    • Returns: Formatted text representation of all available blueprints
  2. get_blueprint

    • Retrieve information about a specific blueprint by its identifier
    • Required inputs:
      • blueprint_identifier (string): The unique identifier of the blueprint to retrieve
    • Optional inputs:
      • detailed (boolean, default: true): Return complete schema details
    • Returns: Formatted text representation of the specified blueprint

Entity Tools

Will be added in the future.

Development

Local Setup

  1. Create and activate a virtual environment:
# Create and activate virtual environment
python -m venv .venv
source .venv/bin/activate  # On Unix/macOS
# or
.venv\Scripts\activate  # On Windows
  1. Install dependencies:
# Install in development mode
pip install -e .

# Install development dependencies
pip install -r requirements-dev.txt
  1. Run the server locally:
python -m src.mcp_server_port --client-id "CLIENT_ID" --client-secret "CLIENT_SECRET" --region "REGION"

Publishing a New Version

To build and publish a new version to PyPI:

# Ensure you have the latest build tools
pip install --upgrade build twine

# Update version in pyproject.toml

# Build the package
python -m build

# Check the package
twine check dist/*

# Upload to PyPI
twine upload dist/mcp_server_port-0.1.4*

Troubleshooting

If you encounter authentication errors, verify that:

  1. Your Port credentials are correctly set in the arguments
  2. You have the necessary permissions
  3. The credentials are properly copied to your configuration

License

This MCP server is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see the LICENSE file in the project repository.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcp_server_port-0.1.5.tar.gz (13.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcp_server_port-0.1.5-py3-none-any.whl (20.6 kB view details)

Uploaded Python 3

File details

Details for the file mcp_server_port-0.1.5.tar.gz.

File metadata

  • Download URL: mcp_server_port-0.1.5.tar.gz
  • Upload date:
  • Size: 13.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.16

File hashes

Hashes for mcp_server_port-0.1.5.tar.gz
Algorithm Hash digest
SHA256 864516002459c491678ae97caebd1137093c9fbe89bbee6215e2b46b96b63bf2
MD5 d2234ee4e834c32760dc4fca2d887475
BLAKE2b-256 ee7ef62b6e569651c5a6ed0892035be60eaf52187b4d24e72a49576abbba3657

See more details on using hashes here.

File details

Details for the file mcp_server_port-0.1.5-py3-none-any.whl.

File metadata

File hashes

Hashes for mcp_server_port-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 75b97a9955c7508e08fa07bb3cb290c8e55289f1e8a604b8b7e0456b253d895a
MD5 e336341f95182fb362eba6ff634fa6bf
BLAKE2b-256 09dbaf604249f21a2381715cc9e955374e061b44a4089a823ade37dd0d5064b5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page