Skip to main content

Check out Port for yourselfย 

Port MCP server


The Port Model Context Protocol (MCP) Server acts as a bridge, enabling Large Language Models (LLMs)โ€”like those powering Claude, Cursor, or GitHub Copilotโ€”to interact directly with your Port.io developer portal. This allows you to leverage natural language to query your software catalog, analyze service health, manage resources, and even streamline development workflows, all from your preferred interfaces.

AI Agents vs. MCP Server

The Port MCP Server is currently in open beta and provides significant standalone value, independent of our AI Agents feature. Port AI Agents are currently in closed beta with limited access, while the MCP Server gives you immediate access to streamline building in Port, query your catalog, analyze service health, and streamline development workflows using natural language.

While the MCP Server can interact with Port AI Agents when available, the core MCP functionality can be used freely without requiring access to the closed beta AI Agents feature.

Why integrate LLMs with your developer portal?โ€‹

The primary advantage of the Port MCP Server is the ability to bring your developer portal's data and actions into the conversational interfaces you already use. This offers several benefits:

  • Reduced Context Switching: Access Port information and initiate actions without leaving your IDE or chat tool.
  • Increased Efficiency: Get answers and perform tasks faster using natural language commands.
  • Improved Developer Experience: Make your developer portal more accessible and intuitive to interact with.
  • Enhanced Data-Driven Decisions: Easily pull specific data points from Port to inform your work in real-time.

As one user put it:

"It would be interesting to build a use case where a developer could ask Copilot from his IDE about stuff Port knows about, without actually having to go to Port."

The Port MCP Server directly enables these kinds of valuable, in-context interactions.

Key capabilities and use-casesโ€‹

The Port MCP Server enables you to interact with your Port data and capabilities directly through natural language within your chosen LLM-powered tools. Here's what you can achieve:

Find information quicklyโ€‹

Effortlessly query your software catalog and get immediate answers. This eliminates the need to navigate through UIs or write complex API queries when you need information.

  • Ask: "Who is the owner of service X?"
  • Ask: "How many services do we have in production?"
  • Ask: "Show me all the microservices owned by the Backend team."
  • Ask: "What are the dependencies of the 'OrderProcessing' service?"

Querying the service catalog from an IDE

Vibe-build in Portโ€‹

Leverage Claude's capabilities to manage and build your entire Port software catalog. You can create and configure blueprints, set up self-service actions, design scorecards, and more.

  • Ask: "Please help me apply this guide into my Port instance - [[guide URL]]"
  • Ask: "I want to start managing my k8s deployments, how can we build it in Port?"
  • Ask: "I want a new production readiness scorecard to track the code quality and service alerts"
  • Ask: "Create a new self-service action in Port to scaffold a new service"

Claude building a self-service action

Analyze scorecards and qualityโ€‹

Gain insights into service health, compliance, and quality by leveraging Port's scorecard data. Identify areas for improvement and track progress against your standards.

  • Ask: "Which services are failing our security requirements scorecard?"
  • Ask: "What's preventing the 'InventoryService' from reaching Gold level in the 'Production Readiness' scorecard?"
  • Ask: "Show me the bug count vs. test coverage for all Java microservices."

Asking about bug counts and test coverage correlation

  • Ask: "Which of our services are missing critical monitoring dashboards?"

Identifying services lacking proper monitoring

Streamline development and operationsโ€‹

Receive assistance with common development and operational tasks, directly within your workflow.

  • Ask: "What do I need to do to set up a new 'ReportingService'?"
  • Ask: "Guide me through creating a new component blueprint with 'name', 'description', and 'owner' properties."
  • Ask: "Help me add a rule to the 'Tier1Services' scorecard that requires an on-call schedule to be defined."

Getting instructions for new service setup

Using Port MCPโ€‹

Setupโ€‹

Setting up Port's MCP is simple. Follow the instructions for your preferred tool, or learn about the archived local MCP server.

To connect Cursor to Port's remote MCP, follow these steps:

  1. Go to Cursor settings, click on Tools & Integrations, and add a new MCP server

Go to Cursor Settings

  1. Add the above configuration

Use the appropriate configuration for your region:

{
"mcpServers": {
"port-eu": {
"url": "https://mcp.port.io/v1"
}
}
}

Add configuration

  1. Login to Port Click on "Needs login", and complete the authentication flow in the window that opens up. Login to Port

  2. See the MCP tools After successfully connecting to Port, you'll see the list of available tools from the MCP. See tools

Authentication window behavior

In some cases, after clicking "Accept" in the authentication popup, the window won't get closed but the connection is established successfully. You can safely close the window.

If you still don't see the tool, try it a couple of times. We are aware of this behavior and working to improve it.

Available toolsโ€‹

The Port MCP Server exposes different sets of tools based on your role and use case. The tools you see will depend on your permissions in Port.

Developers are typically users who consume and interact with the developer portal - querying services, running actions, and analyzing data. These tools help you get information and execute approved workflows.

Query and analysis tools

  • get_blueprints: Retrieve a list of all blueprints from Port.
  • get_blueprint: Retrieve information about a specific blueprint by its identifier.
  • get_entities: Retrieve all entities for a given blueprint.
  • get_entity: Retrieve information about a specific entity.
  • get_scorecards: Retrieve all scorecards from Port.
  • get_scorecard: Retrieve information about a specific scorecard by its identifier.
  • describe_user_details: Get information about your Port account, organization, and user profile details.
  • search_port_docs_sources: Search through Port documentation sources for relevant information.
  • ask_port_docs: Ask questions about Port documentation and get contextual answers.

Action execution tools

  • run_<action_identifier>: Execute any action you have permission to run in Port. The action_identifier corresponds to the identifier of the action you want to run. For example, if you have an action with the identifier scaffold_microservice, you can run it using run_scaffold_microservice.

AI agent tools

Select which tools to useโ€‹

By default, when you open a chat with Port MCP, all available tools (based on your permissions) are loaded and ready to use. However, you can customize which tools are available if you want to focus on specific workflows.

For example, if you only want to query data from Port without building or modifying anything, you can limit the tools to just the read-only ones. This can help reduce complexity and ensure you don't accidentally make changes.

In Cursor, you can customize which tools are available through the UI after connecting to Port MCP. Once connected, you can select specific tools through Cursor's interface as shown below.

Enabling specific tools in Cursor

Troubleshootingโ€‹

If you encounter issues while setting up or using the Port MCP Server, expand the relevant section below:

How can I connect to the MCP? (Click to expand)

Refer back to the setup instructions for your specific application (Cursor, VSCode, or Claude). Make sure you're using the correct regional URL for your Port organization.

I completed the connection but nothing happens (Click to expand)

Check that you've followed all the setup steps correctly for your application. Ensure you're authenticated with Port and have the necessary permissions. If you've followed all the steps and still have issues, please reach out to our support team.

How can I use the MCP server? (Click to expand)

Once connected, you can interact with Port through natural language in your application's chat interface. Ask questions about your software catalog, request help with building Port resources, or analyze your data. The available tools depend on your permissions (Developer vs Builder role).

Why do I see an error about too many tools? (Click to expand)

Each self-service action in your Port instance becomes an individual tool (as run_<action_identifier>). If your organization has many actions, this can result in a large number of tools being available.

While most AI models handle this well, some have restrictions and may limit you to around 40 tools total. If you encounter errors about tool limits:

  1. Reduce the number of tools by customizing which tools are enabled (see Select which tools to use section above)
  2. Focus on essential tools by only enabling the read-only tools you need plus a few key actions
  3. Contact your Port Admin to review which actions are essential for your workflow

This is completely normal behavior and doesn't indicate a problem with Port MCP - it's just a limitation of some AI models.

Getting Help

If you continue to experience issues, please reach out to Port support with:

  • Your IDE/application version
  • The specific error messages you're seeing
  • Your Port region (EU/US)
  • Steps you've already tried

This information will help us provide more targeted assistance.