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

There are two ways to publish a new version: manually following all steps, or using the automated Make commands.

Manual Process

  1. Ensure you're on the main branch and it's up to date:
git checkout main
git pull origin main
  1. Merge the feature/release branch with changelog updates:
git merge feature/your-release-branch
  1. Update version in pyproject.toml

  2. Commit version bump:

git add pyproject.toml
git commit -m "chore: bump version to X.Y.Z"
git push origin main
  1. Create and push a new Git tag:
git tag -a vX.Y.Z -m "Release version X.Y.Z"
git push origin vX.Y.Z
  1. Build and publish to PyPI:
# Ensure you have the latest build tools
pip install --upgrade build twine

# Build the package
python -m build

# Check the package
twine check dist/*

# Upload to PyPI
twine upload dist/mcp_server_port-X.Y.Z*
  1. Create a GitHub release:
    • Go to the repository's Releases page
    • Click "Create new release"
    • Select the tag you just pushed
    • Title it "Release X.Y.Z"
    • Include the changelog in the description
    • Publish the release

Automated Process

You can use the provided Makefile commands to automate the release process:

# Update version and create release
make release VERSION=X.Y.Z

# Or run steps individually:
make bump-version VERSION=X.Y.Z  # Updates pyproject.toml
make tag VERSION=X.Y.Z          # Creates and pushes git tag
make build                      # Builds the package
make publish                    # Publishes to PyPI

Note: The automated process still requires you to manually create the GitHub release with changelog information.

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.6.tar.gz (14.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.6-py3-none-any.whl (22.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mcp_server_port-0.1.6.tar.gz
  • Upload date:
  • Size: 14.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.6.tar.gz
Algorithm Hash digest
SHA256 6426f217ad52bbbba34f965be28e63e84929de03bd54b73b4bf2f43922959057
MD5 1e32673bac21665420f3ef7ac7d868f2
BLAKE2b-256 1f1f0b911e33e37ce09d238e8155d93a8a25d0116cd49fdb08e9811424ab64da

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mcp_server_port-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 469baa74b885f04b0c8bc9190825338edcb3a3328a583e823a1a4c932b2d6fae
MD5 dfce63409475f2db94fe2fce32148c73
BLAKE2b-256 5f93d32fc11face5f79cc337d718eb41b01631c7c2635a57917950815bdb8e4a

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