Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/ai-interfaces/port-mcp-server/available-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,5 +59,17 @@ When creating a custom connector in Claude, you can specify exactly which tools

Refer to the [Claude custom connector documentation](https://support.anthropic.com/en/articles/11175166-getting-started-with-custom-connectors-using-remote-mcp) for detailed instructions.

</TabItem>
<TabItem value="windsurf" label="Windsurf">

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

To manage tools in Windsurf:
1. Go to **Settings** > **Tools** > **Windsurf Settings**
2. Find your Port MCP server configuration
3. Select or deselect specific tools as needed

If you need to limit tools programmatically, you can edit the `mcp_config.json` file directly, though the UI method is recommended for easier management.

</TabItem>
</Tabs>
4 changes: 2 additions & 2 deletions docs/ai-interfaces/port-mcp-server/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ If you encounter issues while setting up or using the Port MCP Server, expand th
<details>
<summary>How can I connect to the MCP? (Click to expand)</summary>

Refer back to the [setup instructions](./overview-and-installation#installing-port-mcp) for your specific application (Cursor, VSCode, or Claude). Make sure you're using the correct regional URL for your Port organization.
Refer back to the [setup instructions](./overview-and-installation#installing-port-mcp) for your specific application (Cursor, VSCode, Windsurf, or Claude). Make sure you're using the correct regional URL for your Port organization.

</details>

Expand Down Expand Up @@ -38,7 +38,7 @@ This is completely normal behavior and doesn't indicate a problem with Port MCP

:::tip Getting Help
If you continue to experience issues, please reach out to Port support with:
- Your IDE/application version
- Your IDE/application version (e.g., Windsurf version, Cursor version)
- The specific error messages you're seeing
- Your Port region (EU/US)
- Steps you've already tried
Expand Down
133 changes: 133 additions & 0 deletions docs/generalTemplates/_mcp-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,139 @@ Failed to validate tool mcp_port_create_action: Error: tool parameters array typ

<img src="/img/ai-agents/MCPVSCodeSetup.gif" border="1px" width="100%" />

</TabItem>
<TabItem value="windsurf" label="Windsurf">
To connect Windsurf to Port's remote MCP server, follow these steps:

:::tip Prerequisites
Windsurf supports remote MCP servers via HTTP transport. Ensure you have Node.js installed if using the command-based configuration method (Method 2).
:::

**Step 1: Locate Windsurf MCP Configuration File**

The MCP configuration file is typically located at:
- **macOS/Linux**: `~/.codeium/windsurf/mcp_config.json`
- **Windows**: `%USERPROFILE%\.codeium\windsurf\mcp_config.json`

If the file doesn't exist, create it with an empty JSON object: `{}`

**Step 2: Configure Port MCP Server**

You can use one of two methods to connect to Port's remote MCP server:

**Method 1: URL-based Configuration (Recommended)**

Add the Port MCP server configuration using the appropriate URL for your region:

<Tabs>
<TabItem value="eu" label="EU">

```json showLineNumbers
{
"mcpServers": {
"port-windsurf-eu": {
"url": "https://mcp.port.io/v1"
}
}
}
```

</TabItem>
<TabItem value="us" label="US">

```json showLineNumbers
{
"mcpServers": {
"port-windsurf-us": {
"url": "https://mcp.us.port.io/v1"
}
}
}
```

</TabItem>
</Tabs>

**Method 2: Command-based Configuration (Alternative)**

If URL-based configuration doesn't work, you can use the `mcp-remote` package similar to VSCode:

<Tabs>
<TabItem value="eu" label="EU">

```json showLineNumbers
{
"mcpServers": {
"port-windsurf-eu": {
"command": "npx",
"args": [
"-y",
"mcp-remote",
"https://mcp.port.io/v1"
]
}
}
}
```

</TabItem>
<TabItem value="us" label="US">

```json showLineNumbers
{
"mcpServers": {
"port-windsurf-us": {
"command": "npx",
"args": [
"-y",
"mcp-remote",
"https://mcp.us.port.io/v1"
]
}
}
}
```

</TabItem>
</Tabs>

**Step 3: Restart Windsurf**

After saving the configuration file:
1. Completely quit Windsurf (don't just close the window)
2. Wait 5 seconds
3. Reopen Windsurf
4. Wait 20 seconds for initialization

**Step 4: Authenticate with Port**

When you first use Port tools in Windsurf, you'll be prompted to authenticate:
1. Click on the authentication prompt or "Needs login" indicator
2. Complete the OAuth flow in the browser window that opens
3. After successful authentication, Port tools should be available

**Step 5: Verify Connection**

1. Start a new chat session in Windsurf
2. Look for Port MCP tools in the available tools list
3. Try asking a question like "List all blueprints in Port" to verify the connection

:::warning Configuration File Location
If you can't find the `mcp_config.json` file, check Windsurf's settings:
- Go to **Settings** > **Tools** > **Windsurf Settings**
- Look for MCP server configuration options
- You may need to use "View Raw Config" to edit the configuration file directly
:::

:::tip Troubleshooting
If the connection doesn't work:
- Ensure the JSON syntax is correct (no missing commas, proper quotes)
- Try Method 2 if Method 1 doesn't work
- Check Windsurf's logs for error messages
- Verify your Port region (EU/US) matches the URL you're using
- See the [troubleshooting guide](/ai-interfaces/port-mcp-server/troubleshooting) for more help
:::

</TabItem>
<TabItem value="claude" label="Claude">
To connect Claude to Port's remote MCP, you need to create a custom connector. This process does not require a client ID. For detailed instructions, refer to the [official Anthropic documentation on custom connectors](https://support.anthropic.com/en/articles/11175166-getting-started-with-custom-connectors-using-remote-mcp).
Expand Down