Skip to content

Commit 0b27c81

Browse files
committed
Enhance documentation for Port MCP server by adding installation guide and improving image formatting. Updated the overview and installation guide to include a reference to the MCP installation template and modified image tags for better display. Additionally, refined the DORA metrics query guide with improved layout and examples, ensuring clarity and accessibility for users.
1 parent 2da0604 commit 0b27c81

27 files changed

+184
-68
lines changed

docs/ai-interfaces/port-mcp-server/overview-and-installation.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ title: Overview & Installation
55

66
import Tabs from "@theme/Tabs"
77
import TabItem from "@theme/TabItem"
8+
import MCPInstallation from '/docs/generalTemplates/_mcp-installation.md'
89

910
# Port MCP server
1011

@@ -75,7 +76,7 @@ Effortlessly query your software catalog and get immediate answers. This elimina
7576
* Ask: "Show me all the microservices owned by the Backend team."
7677
* Ask: "What are the dependencies of the 'OrderProcessing' service?"
7778

78-
![Querying the service catalog from an IDE](/img/ai-agents/MCPCopilotAskServices.png)
79+
<img src="/img/ai-agents/MCPCopilotAskServices.png" width="100%" border="1px" />
7980

8081
### Vibe-build in Port
8182

@@ -86,7 +87,7 @@ Leverage Claude's capabilities to manage and build your entire Port software cat
8687
* Ask: "I want a new production readiness scorecard to track the code quality and service alerts"
8788
* Ask: "Create a new self-service action in Port to scaffold a new service"
8889

89-
![Claude building a self-service action](/img/ai-agents/MCPClaudeBuildSSA.png)
90+
<img src="/img/ai-agents/MCPClaudeBuildSSA.png" width="100%" border="1px" />
9091

9192
### Analyze scorecards and quality
9293

@@ -96,11 +97,11 @@ Gain insights into service health, compliance, and quality by leveraging Port's
9697
* Ask: "What's preventing the 'InventoryService' from reaching Gold level in the 'Production Readiness' scorecard?"
9798
* Ask: "Show me the bug count vs. test coverage for all Java microservices."
9899

99-
![Asking about bug counts and test coverage correlation](/img/ai-agents/MCPClaudeInsightsBugs.png)
100+
<img src="/img/ai-agents/MCPClaudeInsightsBugs.png" width="100%" border="1px" />
100101

101102
* Ask: "Which of our services are missing critical monitoring dashboards?"
102103

103-
![Identifying services lacking proper monitoring](/img/ai-agents/MCPClaudeMonitoringServices.png)
104+
<img src="/img/ai-agents/MCPClaudeMonitoringServices.png" width="100%" border="1px" />
104105

105106
### Streamline development and operations
106107

@@ -110,15 +111,12 @@ Receive assistance with common development and operational tasks, directly withi
110111
* Ask: "Guide me through creating a new component blueprint with 'name', 'description', and 'owner' properties."
111112
* Ask: "Help me add a rule to the 'Tier1Services' scorecard that requires an on-call schedule to be defined."
112113

113-
![Getting instructions for new service setup](/img/ai-agents/MCPClaudeServiceSetup.png)
114+
<img src="/img/ai-agents/MCPClaudeServiceSetup.png" width="100%" border="1px" />
114115

115116
### Find your own use cases
116117

117118
You can use Port's MCP to find the use cases that will be valuable to you. Try using this prompt: "think of creative prompts I can use to showcase the power of Port's MCP, based on the data available in Port"
118119

119-
120-
import MCPInstallation from '/docs/generalTemplates/_mcp-installation.md'
121-
122120
<MCPInstallation />
123121

124122
## Token-based authentication

docs/generalTemplates/_mcp-installation.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ To connect Cursor to Port's remote MCP, follow these steps:
1313

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

16-
![Go to Cursor Settings](/img/ai-agents/MCPInstallCursorStep1.png)
16+
<img src="/img/ai-agents/MCPInstallCursorStep1.png" border="1px" width="100%" />
1717

1818
2. **Configure the MCP server**
1919

@@ -48,19 +48,19 @@ To connect Cursor to Port's remote MCP, follow these steps:
4848
</TabItem>
4949
</Tabs>
5050

51-
![Add configuration](/img/ai-agents/MCPInstallCursorStep2.png)
51+
<img src="/img/ai-agents/MCPInstallCursorStep2.png" border="1px" width="100%" />
5252

5353
3. **Authenticate with Port**
5454

5555
Click on **"Needs login"** and complete the authentication flow in the window that opens.
5656

57-
![Login to Port](/img/ai-agents/MCPInstallCursorStep3.png)
57+
<img src="/img/ai-agents/MCPInstallCursorStep3.png" border="1px" width="100%" />
5858

5959
4. **Verify connection**
6060

6161
After successful authentication, you'll see the list of available tools from the MCP server.
6262

63-
![See tools](/img/ai-agents/MCPInstallCursorStep4.png)
63+
<img src="/img/ai-agents/MCPInstallCursorStep4.png" border="1px" width="100%" />
6464

6565
:::warning Authentication window behavior
6666
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.
@@ -164,7 +164,7 @@ Failed to validate tool mcp_port_create_action: Error: tool parameters array typ
164164
2. Click on the tools icon in the chat interface
165165
3. You should now see Port tools available for use
166166

167-
![VS Code MCP Setup](/img/ai-agents/MCPVSCodeSetup.gif)
167+
<img src="/img/ai-agents/MCPVSCodeSetup.gif" border="1px" width="100%" />
168168

169169
</TabItem>
170170
<TabItem value="claude" label="Claude">

0 commit comments

Comments
 (0)