Skip to content

Commit 5e9add4

Browse files
authored
Merge branch 'main' into add-link-to-integration-pages
2 parents ddff1d3 + 8cdf28d commit 5e9add4

File tree

51 files changed

+6916
-3038
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+6916
-3038
lines changed

docs/ai-agents/port-mcp-server.md

Lines changed: 0 additions & 626 deletions
This file was deleted.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"label": "AI agents & MCP server",
2+
"label": "AI interfaces",
33
"position": 9,
44
"className": "custom-sidebar-item sidebar-menu-ai-agents"
55
}
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"label": "AI agents",
3+
"position": 1
4+
}

docs/ai-agents/build-an-ai-agent.md renamed to docs/ai-interfaces/ai-agents/build-an-ai-agent.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Let's walk through the process of creating an agent that can assist your develop
1818

1919
## Create a new AI agent
2020

21-
To create a new agent, head to the AI Agents catalog page (this page will be created for you when you [activate the feature](/ai-agents/overview#access-to-the-feature)).
21+
To create a new agent, head to the AI Agents catalog page (this page will be created for you when you [activate the feature](/ai-interfaces/ai-agents/overview#access-to-the-feature)).
2222

2323
Click on the "New AI Agent" button and fill the form with the agent details.
2424
<img src='/img/ai-agents/AIAgentsList.png' width='80%' border='1px' />
@@ -27,7 +27,7 @@ Click on the "New AI Agent" button and fill the form with the agent details.
2727
We recommend following the steps below.
2828

2929
:::info MCP Server Backend Mode
30-
AI agents can be enhanced with MCP server backend mode for expanded capabilities including intelligent catalog access and Claude model processing. This is controlled when [interacting with the agents](/ai-agents/interact-with-ai-agents) through widgets and API calls, not in the agent configuration itself.
30+
AI agents can be enhanced with MCP server backend mode for expanded capabilities including intelligent catalog access and Claude model processing. This is controlled when [interacting with the agents](/ai-interfaces/ai-agents/interact-with-ai-agents) through widgets and API calls, not in the agent configuration itself.
3131
:::
3232

3333
### Step 1: Define your agent's purpose
@@ -56,7 +56,7 @@ For example:
5656
Pay attention to relationships between entities to ensure your agent can provide comprehensive answers.
5757

5858
:::tip Enhanced access with MCP server backend
59-
When using [MCP server backend mode](/ai-agents/interact-with-ai-agents) during interactions, the agent can intelligently access your entire catalog regardless of configured blueprints, providing more comprehensive answers.
59+
When using [MCP server backend mode](/ai-interfaces/ai-agents/interact-with-ai-agents) during interactions, the agent can intelligently access your entire catalog regardless of configured blueprints, providing more comprehensive answers.
6060
:::
6161

6262
### Step 3: Configure actions (optional)
@@ -155,7 +155,7 @@ Choose conversation starters that:
155155
When you feel your agent is ready:
156156

157157
1. Set its status to "Active".
158-
2. Start interacting with it through the [available interfaces](/ai-agents/interact-with-ai-agents).
158+
2. Start interacting with it through the [available interfaces](/ai-interfaces/ai-agents/interact-with-ai-agents).
159159

160160
## Evaluating your agent performance
161161

@@ -166,7 +166,7 @@ Continuous evaluation and improvement are essential for maintaining effective AI
166166
3. **Analyze execution plans**: Examine how the agent processes requests by reviewing the execution plan and tool calls for specific invocations. This helps identify where improvements are needed.
167167
4. **Refine the prompt**: Update your agent's prompt based on your findings to address common issues.
168168

169-
For more details on how to view execution plans and analyze agent behavior, see [Interact with AI agents](/ai-agents/interact-with-ai-agents).
169+
For more details on how to view execution plans and analyze agent behavior, see [Interact with AI agents](/ai-interfaces/ai-agents/interact-with-ai-agents).
170170

171171
## Examples
172172

@@ -194,7 +194,7 @@ Your goal is to help developers initiate and track deployments to various enviro
194194
## Formatting the agent response
195195
To format the agent's response, you can specify the desired format in its prompt. For optimal results when using the UI, it's recommended to request a markdown format response.
196196
This allows for better presentation and readability of the information provided by the agent.
197-
When sending messages through Slack, our [Slack app](/ai-agents/slack-app) convert the markdown format into a Slack compatible formatting.
197+
When sending messages through Slack, our [Slack app](/ai-interfaces/ai-agents/slack-app) convert the markdown format into a Slack compatible formatting.
198198

199199
### Example of a Markdown Response
200200
```markdown
@@ -208,7 +208,7 @@ From [john-123](https://github.com/john-123)
208208
<details>
209209
<summary><b>I don't see an option to add an AI agent (Click to expand)</b></summary>
210210

211-
Make sure you have [access to the AI agents feature](/ai-agents/overview#access-to-the-feature). Note that it's currently in closed beta and requires special access. If you believe you should have access, please contact our support.
211+
Make sure you have [access to the AI agents feature](/ai-interfaces/ai-agents/overview#access-to-the-feature). Note that it's currently in closed beta and requires special access. If you believe you should have access, please contact our support.
212212
</details>
213213

214214
<details>
@@ -244,7 +244,7 @@ AI agents in Port can search, group, and index entities in your Port instance. H
244244
- Sequential automations run as Admin.
245245

246246
:::info Enhanced capabilities with MCP server backend
247-
When using [MCP server backend mode](/ai-agents/interact-with-ai-agents) during interactions, many of these limitations are reduced as the agent gains access to enhanced tools and broader data access capabilities.
247+
When using [MCP server backend mode](/ai-interfaces/ai-agents/interact-with-ai-agents) during interactions, many of these limitations are reduced as the agent gains access to enhanced tools and broader data access capabilities.
248248
:::
249249
</details>
250250

@@ -257,4 +257,4 @@ When configuring your agent's actions, make sure you select the "approval" optio
257257
## Security considerations
258258

259259
AI agents in Port are designed with security and privacy as a priority.
260-
For more information on security and data handling, see our [AI agents overview](/ai-agents/overview#security-and-data-handling).
260+
For more information on security and data handling, see our [AI agents overview](/ai-interfaces/ai-agents/overview#security-and-data-handling).

docs/ai-agents/interact-with-ai-agents.md renamed to docs/ai-interfaces/ai-agents/interact-with-ai-agents.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ The Slack integration provides the most natural way to interact with Port's AI a
8080

8181
You can interact with agents in two ways:
8282

83-
1. **Direct messaging** the [Port Slack app](/ai-agents/slack-app). This will use the agent router.
83+
1. **Direct messaging** the [Port Slack app](/ai-interfaces/ai-agents/slack-app). This will use the agent router.
8484
2. **Mentioning** the app in any channel it's invited to. This will also use the agent router.
8585

8686
When you send a message, the app will:
@@ -277,7 +277,7 @@ AI agents are standard Port entities belonging to the `_ai_agent` blueprint. Thi
277277

278278
You can discover available AI agents in your Port environment in a couple of ways:
279279

280-
1. **AI Agents Catalog Page**: Navigate to the AI Agents catalog page in Port. This page lists all the agents that have been created in your organization. For more details on creating agents, refer to the [Build an AI agent guide](/ai-agents/build-an-ai-agent).
280+
1. **AI Agents Catalog Page**: Navigate to the AI Agents catalog page in Port. This page lists all the agents that have been created in your organization. For more details on creating agents, refer to the [Build an AI agent guide](/ai-interfaces/ai-agents/build-an-ai-agent).
281281
2. **Via API**: Programmatically retrieve a list of all AI agents using the Port API. AI agents are entities of the `_ai_agent` blueprint. You can use the [Get all entities of a blueprint API endpoint](https://docs.port.io/api-reference/get-all-entities-of-a-blueprint) to fetch them, specifying `_ai_agent` as the blueprint identifier.
282282

283283
<details>
@@ -379,7 +379,7 @@ For **MCP Server Backend Mode:**
379379

380380
AI agent interactions in Port are designed with security and privacy as a priority.
381381

382-
For more information on security and data handling, see our [AI agents overview](/ai-agents/overview#security-and-data-handling).
382+
For more information on security and data handling, see our [AI agents overview](/ai-interfaces/ai-agents/overview#security-and-data-handling).
383383

384384
## Troubleshooting & FAQ
385385

@@ -409,7 +409,7 @@ We're working on adding direct interaction through the Port UI in the future.
409409

410410
Each agent has optional conversation starters to help you understand what it can help with. The questions you can ask depend on which agents were built in your organization.
411411

412-
For information on building agents with specific capabilities, see our [Build an AI agent](/ai-agents/build-an-ai-agent) guide.
412+
For information on building agents with specific capabilities, see our [Build an AI agent](/ai-interfaces/ai-agents/build-an-ai-agent) guide.
413413
</details>
414414

415415
<details>
@@ -435,7 +435,7 @@ Remember that AI agents are constantly learning and improving, but they're not i
435435
<summary><b>My agent isn't responding in Slack (Click to expand)</b></summary>
436436

437437
Ensure that:
438-
- The [Port Slack app](/ai-agents/slack-app) is properly installed in your workspace.
438+
- The [Port Slack app](/ai-interfaces/ai-agents/slack-app) is properly installed in your workspace.
439439
- The app has been invited to the channel where you're mentioning it.
440440
- You're correctly mentioning the app (@Port).
441441
- You've completed the authentication flow with the app.

docs/ai-agents/overview.md renamed to docs/ai-interfaces/ai-agents/overview.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ When using the MCP server backend mode, your AI agents gain:
4343
- **Broader tool access**: Uses all read-only tools available in the MCP server for comprehensive insights
4444
- **Smarter action selection**: Still respects your configured allowed actions while providing better context
4545

46-
Your existing agents can immediately benefit from these enhancements by enabling the MCP server backend mode when [interacting with them](/ai-agents/interact-with-ai-agents) through widgets and API calls.
46+
Your existing agents can immediately benefit from these enhancements by enabling the MCP server backend mode when [interacting with them](/ai-interfaces/ai-agents/interact-with-ai-agents) through widgets and API calls.
4747

4848
### Example use cases
4949

@@ -61,18 +61,18 @@ Your existing agents can immediately benefit from these enhancements by enabling
6161
To start working with AI agents, follow these steps:
6262

6363
1. **Apply for access** - Submit your application via [this form](https://forms.gle/krhMY7c9JM8MyJJf7).
64-
2. **Access the feature** - If accepted, you will be able to [activate the AI agents](/ai-agents/overview#access-to-the-feature) in your Port organization.
65-
3. **Build your agents** - [Create custom agents](/ai-agents/build-an-ai-agent) to meet your developers' needs.
66-
4. **Interact with your agents** - Engage with your agents by following our [interaction guide](/ai-agents/interact-with-ai-agents).
64+
2. **Access the feature** - If accepted, you will be able to [activate the AI agents](/ai-interfaces/ai-agents/overview#access-to-the-feature) in your Port organization.
65+
3. **Build your agents** - [Create custom agents](/ai-interfaces/ai-agents/build-an-ai-agent) to meet your developers' needs.
66+
4. **Interact with your agents** - Engage with your agents by following our [interaction guide](/ai-interfaces/ai-agents/interact-with-ai-agents).
6767

6868
## Customization and control
6969

70-
[Build and customize](/ai-agents/build-an-ai-agent) your AI agents:
70+
[Build and customize](/ai-interfaces/ai-agents/build-an-ai-agent) your AI agents:
7171
- Define which data sources your agents can access.
7272
- Determine what actions your agents can assist with.
7373
- Set permissions for who can use specific agents.
7474
- Configure how agents integrate with your workflows.
75-
- Choose between standard and MCP server backend modes when [interacting with agents](/ai-agents/interact-with-ai-agents).
75+
- Choose between standard and MCP server backend modes when [interacting with agents](/ai-interfaces/ai-agents/interact-with-ai-agents).
7676

7777
## Security and data handling
7878

@@ -101,9 +101,9 @@ Your organization now has the system blueprints required for the feature to work
101101
## Data Model
102102
The data model of AI agents includes two main blueprints:
103103

104-
1. **AI agents** - The agents themselves that you can interact with. You can build new ones and customize them as you wish. Learn more in our [Build an AI agent](/ai-agents/build-an-ai-agent) guide.
104+
1. **AI agents** - The agents themselves that you can interact with. You can build new ones and customize them as you wish. Learn more in our [Build an AI agent](/ai-interfaces/ai-agents/build-an-ai-agent) guide.
105105

106-
2. **AI invocations** - Each interaction made with an AI agent is recorded as an invocation. This acts as a log of everything going through your AI agents so you can monitor and improve them over time. Learn more in our [Interact with AI agents](/ai-agents/interact-with-ai-agents) guide.
106+
2. **AI invocations** - Each interaction made with an AI agent is recorded as an invocation. This acts as a log of everything going through your AI agents so you can monitor and improve them over time. Learn more in our [Interact with AI agents](/ai-interfaces/ai-agents/interact-with-ai-agents) guide.
107107

108108
## Relevant guides
109109

@@ -139,7 +139,7 @@ Port AI supports two primary interaction types:
139139
<details>
140140
<summary>How do users interact with Port AI? (Click to expand)</summary>
141141

142-
- Primary interface is through our [Slack app](/ai-agents/slack-app).
142+
- Primary interface is through our [Slack app](/ai-interfaces/ai-agents/slack-app).
143143
- Full [API availability](/api-reference/port-api/).
144144
</details>
145145

docs/ai-agents/slack-app.md renamed to docs/ai-interfaces/ai-agents/slack-app.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ This can be used to get quick answers to questions about your resources, such as
3131
- To install the Slack app, you will first need to apply for access to Port's AI program by filling out [this form](https://forms.gle/krhMY7c9JM8MyJJf7).
3232

3333
- To interact with AI agents, you need to have at least one agent deployed in your portal.
34-
See the [Build an AI agent](https://docs.port.dev/ai-agents/build-an-ai-agent) page to learn more.
34+
See the [Build an AI agent](https://docs.port.dev/ai-interfaces/ai-agents/build-an-ai-agent) page to learn more.
3535

3636
## Installation
3737

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"label": "MCP server",
3+
"position": 2
4+
}
Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
---
2+
sidebar_position: 3
3+
title: Tools
4+
---
5+
6+
import Tabs from "@theme/Tabs"
7+
import TabItem from "@theme/TabItem"
8+
9+
# Available tools
10+
11+
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.
12+
13+
<Tabs groupId="user-role" queryString>
14+
<TabItem value="developer" label="Developer">
15+
16+
**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.
17+
18+
**Query and analysis tools**
19+
- **[`get_blueprints`](/api-reference/get-all-blueprints)**: Retrieve a list of all blueprints from Port.
20+
- **[`get_blueprint`](/api-reference/get-a-blueprint)**: Retrieve information about a specific blueprint by its identifier.
21+
- **[`get_entities`](/api-reference/get-all-entities-of-a-blueprint)**: Retrieve all entities for a given blueprint.
22+
- **[`get_entity`](/api-reference/get-an-entity)**: Retrieve information about a specific entity.
23+
- **[`get_scorecards`](/api-reference/get-all-scorecards)**: Retrieve all scorecards from Port.
24+
- **[`get_scorecard`](/api-reference/get-a-scorecard)**: Retrieve information about a specific scorecard by its identifier.
25+
- **[`describe_user_details`](/api-reference/get-organization-details)**: Get information about your Port account, organization, and user profile details.
26+
- **`search_port_docs_sources`**: Search through Port documentation sources for relevant information.
27+
- **`ask_port_docs`**: Ask questions about Port documentation and get contextual answers.
28+
29+
**Action execution tools**
30+
- **[`run_<action_identifier>`](/api-reference/execute-a-self-service-action)**: Execute any action you have permission to run in Port.
31+
32+
**AI agent tools**
33+
- **[`invoke_ai_agent`](/api-reference/invoke-an-agent)**: Invoke a Port AI agent with a specific prompt.
34+
35+
</TabItem>
36+
<TabItem value="builder" label="Builder">
37+
38+
**Builders** are platform engineers or admins who design and configure the developer portal - creating blueprints, setting up scorecards, and managing the overall structure. These tools help you build and maintain the portal.
39+
40+
**All Developer tools**
41+
Builders have access to all the tools available to Developers (listed above), plus the additional management tools below.
42+
43+
**Blueprint management tools**
44+
- **[`create_blueprint`](/api-reference/create-a-blueprint)**
45+
- **[`update_blueprint`](/api-reference/update-a-blueprint)**
46+
- **[`delete_blueprint`](/api-reference/delete-a-blueprint)**
47+
48+
**Entity management tools**
49+
- **[`create_entity`](/api-reference/create-an-entity)**
50+
- **[`update_entity`](/api-reference/update-an-entity)**
51+
- **[`delete_entity`](/api-reference/delete-an-entity)**
52+
53+
**Scorecard management tools**
54+
- **[`create_scorecard`](/api-reference/create-a-scorecard)**
55+
- **[`update_scorecard`](/api-reference/change-scorecards)**
56+
- **[`delete_scorecard`](/api-reference/delete-a-scorecard)**
57+
58+
</TabItem>
59+
</Tabs>
60+
61+
## Select which tools to use
62+
63+
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.
64+
65+
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 helps reduce complexity and ensures you don't accidentally make changes.
66+
67+
<Tabs groupId="tool-selection" queryString>
68+
<TabItem value="cursor" label="Cursor">
69+
70+
In Cursor, you can customize which tools are available through the UI after connecting to Port MCP. Once connected, you can select specific tools as shown below.
71+
72+
![Enabling specific tools in Cursor](/img/ai-agents/MCPCursorEnableTools.png)
73+
74+
</TabItem>
75+
<TabItem value="vscode" label="VSCode">
76+
77+
In VSCode, you can choose the tools through the UI after connecting to Port MCP.
78+
79+
![Enabling specific tools in VSCode](/img/ai-agents/MCPVSCodeEnableTools.png)
80+
81+
</TabItem>
82+
<TabItem value="claude" label="Claude">
83+
84+
When creating a custom connector in Claude, you can specify exactly which tools to expose instead of enabling everything.
85+
86+
![Enabling specific tools in Claude](/img/ai-agents/MCPClaudeEnableTools.png)
87+
88+
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.
89+
90+
</TabItem>
91+
</Tabs>

0 commit comments

Comments
 (0)