Skip to content

Commit 2a86398

Browse files
committed
fix conflict
2 parents 8658bc2 + ff9f8fa commit 2a86398

30 files changed

+1229
-453
lines changed

.github/workflows/claude-pr-reviewer.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ jobs:
1717
runs-on: ubuntu-latest
1818
steps:
1919
- name: Checkout repository
20-
uses: actions/checkout@v4
20+
uses: actions/checkout@v5
2121
with:
2222
fetch-depth: 1
2323

@@ -40,7 +40,7 @@ jobs:
4040
id-token: write
4141
steps:
4242
- name: Checkout repository
43-
uses: actions/checkout@v4
43+
uses: actions/checkout@v5
4444
with:
4545
fetch-depth: 1
4646

@@ -72,5 +72,5 @@ jobs:
7272
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
7373
allowed_tools: "Bash(git:*),Bash(gh:*),Bash(jq:*),Bash(yq:*),View,GlobTool,GrepTool,BatchTool"
7474
direct_prompt: |
75-
Please review the following PR and provide a detailed review of the changes according the ./CONTRIBUTING.md provide results in markdown format.
75+
Please review the following PR and provide a detailed review of the changes according the ./CONTRIBUTING.md provide results in markdown format. Ignore all image files.
7676
timeout_minutes: "15"

.github/workflows/sync-docs-with-mapping-config.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,20 @@ jobs:
1313

1414
steps:
1515
- name: Checkout port-docs (automation tools)
16-
uses: actions/checkout@v4
16+
uses: actions/checkout@v5
1717
with:
1818
path: port-docs
1919

2020
- name: Checkout ocean-test (YAML configs source)
21-
uses: actions/checkout@v4
21+
uses: actions/checkout@v5
2222
with:
2323
repository: ${{ github.repository_owner }}/ocean-test
2424
token: ${{ secrets.MAPPING_PAT }}
2525
path: ocean-test
2626
ref: main
2727

2828
- name: Checkout Port-monorepo (TypeScript source)
29-
uses: actions/checkout@v4
29+
uses: actions/checkout@v5
3030
with:
3131
repository: ${{ github.repository_owner }}/Port-monorepo
3232
token: ${{ secrets.MAPPING_PAT }}

.github/workflows/updateApiSpec.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ jobs:
1616
steps:
1717
# Step 1: Checkout the repository
1818
- name: Checkout repository
19-
uses: actions/checkout@v4
19+
uses: actions/checkout@v5
2020
with:
2121
fetch-depth: 0 # Fetch all history for accurate diff
2222

.github/workflows/verify-docs-build.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ jobs:
1818
runs-on: ubuntu-latest
1919
name: Test successful production build
2020
steps:
21-
- uses: actions/checkout@v4
21+
- uses: actions/checkout@v5
2222
with:
2323
persist-credentials: true
2424
- name: Install dependencies

docs/ai-agents/build-an-ai-agent.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@ Click on the "New AI Agent" button and fill the form with the agent details.
2626

2727
We recommend following the steps below.
2828

29+
:::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.
31+
:::
32+
2933
### Step 1: Define your agent's purpose
3034

3135
The first step in building an AI agent is deciding on its purpose.
@@ -51,6 +55,10 @@ For example:
5155

5256
Pay attention to relationships between entities to ensure your agent can provide comprehensive answers.
5357

58+
:::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.
60+
:::
61+
5462
### Step 3: Configure actions (optional)
5563

5664
If your agent needs to run actions, you will need to:
@@ -234,6 +242,10 @@ AI agents in Port can search, group, and index entities in your Port instance. H
234242
- **Permission model**:
235243
- Interaction with the AI agent is based on your user permissions.
236244
- Sequential automations run as Admin.
245+
246+
:::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.
248+
:::
237249
</details>
238250

239251
<details>

docs/ai-agents/interact-with-ai-agents.md

Lines changed: 66 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,17 @@ import TabItem from "@theme/TabItem"
1515

1616
Once you've built your AI agents, it's time to interact with them. Port provides several ways to communicate with your AI agents.
1717

18+
## Backend mode selection
19+
20+
When interacting with AI agents, you can choose between two backend modes that determine the agent's capabilities:
21+
22+
- **Standard backend**: Uses the agent's configured blueprint access and OpenAI GPT models
23+
- **MCP server backend**: Provides enhanced capabilities with intelligent catalog access and Claude models
24+
25+
:::tip Backend mode is interaction-level
26+
The backend mode is controlled when you interact with agents (through widgets, API calls, etc.), not in the agent configuration itself. This means any agent can benefit from MCP server backend capabilities when you choose to use them.
27+
:::
28+
1829
## Interaction options
1930

2031
You have two main approaches when interacting with AI agents in Port:
@@ -50,6 +61,18 @@ Follow these steps to add an AI agent widget:
5061

5162
The widget provides a chat interface where you can ask questions and receive responses from the **specific agent you configured** without leaving your dashboard.
5263

64+
### MCP server backend mode in widgets
65+
66+
When adding an AI agent widget to your dashboard, you can configure whether to use the MCP server backend mode. During widget configuration, you'll see a "Use MCP" toggle option:
67+
68+
<img src='/img/ai-agents/AIAgentsMCPWidgetConfig.png' width='70%' border='1px' />
69+
70+
When MCP server backend mode is enabled, the widget interface provides enhanced capabilities and visual indicators showing which tools are being used:
71+
72+
<img src='/img/ai-agents/AIAgentsMCPWidgetUI.png' width='80%' border='1px' />
73+
74+
This gives you transparency into the enhanced processing and shows you exactly which MCP server tools the agent is leveraging to answer your questions.
75+
5376
</TabItem>
5477
<TabItem value="slack-integration" label="Slack Integration">
5578

@@ -75,6 +98,10 @@ When you send a message, the app will:
7598
- Limit threads to five consecutive messages for optimal performance.
7699
- For best results, start new threads for new topics or questions.
77100

101+
:::info MCP server backend mode in Slack
102+
Currently, Slack interactions use the agent's default backend mode configuration. The ability to choose or override the backend mode per interaction is not yet available in Slack, but will be added in future updates.
103+
:::
104+
78105
</TabItem>
79106
<TabItem value="actions-automations" label="Actions and automations">
80107

@@ -116,6 +143,24 @@ curl 'https://api.port.io/v1/agent/<AGENT_IDENTIFIER>/invoke?stream=true' \\
116143
--data-raw '{"prompt":"What is my next task?"}'
117144
```
118145

146+
**Using MCP Server Backend Mode via API:**
147+
148+
You can override the agent's default backend mode by adding the `use_mcp` parameter:
149+
150+
```bash
151+
# Force MCP server backend mode
152+
curl 'https://api.port.io/v1/agent/<AGENT_IDENTIFIER>/invoke?stream=true&use_mcp=true' \\
153+
-H 'Authorization: Bearer <YOUR_API_TOKEN>' \\
154+
-H 'Content-Type: application/json' \\
155+
--data-raw '{"prompt":"What is my next task?"}'
156+
157+
# Force standard backend mode
158+
curl 'https://api.port.io/v1/agent/<AGENT_IDENTIFIER>/invoke?stream=true&use_mcp=false' \\
159+
-H 'Authorization: Bearer <YOUR_API_TOKEN>' \\
160+
-H 'Content-Type: application/json' \\
161+
--data-raw '{"prompt":"What is my next task?"}'
162+
```
163+
119164
**Streaming Response Details (Server-Sent Events):**
120165

121166
The API will respond with `Content-Type: text/event-stream; charset=utf-8`.
@@ -259,7 +304,18 @@ The plan shows how the agent decided to tackle your request and the steps it int
259304

260305
### Tools used
261306

262-
This section displays the actual steps the agent took and the APIs it used to complete your request. It can be particularly helpful for debugging when answers don't meet expectations, such as when an agent:
307+
This section displays the actual steps the agent took and the APIs it used to complete your request. The tools shown depend on the backend mode used:
308+
309+
**Standard Backend Mode:**
310+
- Shows traditional agent tools based on configured blueprint access
311+
- Limited to predefined search and query capabilities
312+
313+
**MCP Server Backend Mode:**
314+
- Shows enhanced MCP server tools for comprehensive data access
315+
- Includes all read-only tools available in the MCP server
316+
- Provides more detailed tool execution information
317+
318+
This information can be particularly helpful for debugging when answers don't meet expectations, such as when an agent:
263319

264320
- Used an incorrect field name.
265321
- Chose an inappropriate property.
@@ -308,7 +364,15 @@ Here are some common errors you might encounter when working with AI agents and
308364
This error occurs when an AI agent tries to execute a self-service action that requires selecting entities from specific blueprints, but the agent doesn't have access to those blueprints.
309365

310366
**How to fix:**
311-
Add the missing blueprints listed in the error message to the agent's configuration.
367+
368+
For **Standard Backend Mode:**
369+
- Add the missing blueprints listed in the error message to the agent's configuration.
370+
371+
For **MCP Server Backend Mode:**
372+
- This error is less common since MCP mode has broader data access
373+
- If you encounter this error, it likely relates to action execution requirements
374+
- Ensure the action's entity selection fields are properly configured
375+
- Consider switching to MCP server backend mode for enhanced blueprint access
312376
</details>
313377

314378
## Security considerations

docs/ai-agents/overview.md

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,21 @@ AI agents serve two primary functions:
3030

3131
2. **Assist with actions** by helping developers complete common tasks faster. Agents can suggest and pre-fill forms, guide developers through workflows, and provide relevant context for decision-making. You can decide whether they can run an action or require human approval.
3232

33+
## Enhanced capabilities with MCP server backend
34+
35+
:::tip New capability
36+
Port AI agents now support an enhanced **MCP server backend mode** that provides significantly expanded capabilities. This is a new feature that enhances your existing agents - you can enable it for any agent to unlock these advanced capabilities.
37+
:::
38+
39+
When using the MCP server backend mode, your AI agents gain:
40+
41+
- **Expanded data access**: Intelligently queries your entire catalog without blueprint restrictions
42+
- **Enhanced reasoning**: Powered by Claude models for improved analysis and decision-making
43+
- **Broader tool access**: Uses all read-only tools available in the MCP server for comprehensive insights
44+
- **Smarter action selection**: Still respects your configured allowed actions while providing better context
45+
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.
47+
3348
### Example use cases
3449

3550
**Questions your agents can answer:**
@@ -57,6 +72,7 @@ To start working with AI agents, follow these steps:
5772
- Determine what actions your agents can assist with.
5873
- Set permissions for who can use specific agents.
5974
- 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).
6076

6177
## Security and data handling
6278

@@ -89,6 +105,20 @@ The data model of AI agents includes two main blueprints:
89105

90106
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.
91107

108+
## Relevant guides
109+
110+
Explore these guides to see AI agents in action and learn how to implement them in your organization:
111+
112+
- [Generate incident updates with AI](/guides/all/generate-incident-updates-with-ai)
113+
- [Enrich tasks with AI-powered context](/guides/all/enrich-tasks-with-ai)
114+
- [Setup PR enricher AI agent](/guides/all/setup-pr-enricher-ai-agent)
115+
- [Setup service explorer AI agent](/guides/all/setup-service-explorer-ai-agent)
116+
- [Setup platform request triage AI agent](/guides/all/setup-platform-request-triage-ai-agent)
117+
- [Setup task manager AI agent](/guides/all/setup-task-manager-ai-agent)
118+
- [Setup incident manager AI agent](/guides/all/setup-incident-manager-ai-agent)
119+
- [Add RCA context to AI agents](/guides/all/add-rca-context-to-ai-agents)
120+
- [Enrich security vulnerability using AI](/guides/all/enrich-security-vulnerability-using-ai)
121+
92122
## Frequently asked questions
93123

94124
<details>
@@ -137,7 +167,12 @@ We limit this data storage strictly to these purposes. You can contact us to opt
137167
<details>
138168
<summary>Which LLM models are you using? (Click to expand)</summary>
139169

140-
We aim to use the best models that will yield the best results while keeping your data safe; at the moment, we work with Open AI's GPT models, but this could change in the future.
170+
We use different models depending on the backend mode:
171+
172+
- **Standard backend**: OpenAI's GPT models for reliable performance and broad compatibility
173+
- **MCP server backend**: Claude models for enhanced reasoning and analysis capabilities
174+
175+
We aim to use the best models that will yield the best results while keeping your data safe. Model selection may evolve as we continue to optimize agent performance.
141176
</details>
142177

143178
<details>

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

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import TabItem from "@theme/TabItem"
1414
style={{borderRadius:'4px'}}
1515
width="568"
1616
height="320"
17-
src="https://www.youtube.com/embed/hxUTTPSApQs"
17+
src="https://www.youtube.com/embed/WrVgQ-whBiE"
1818
title="YouTube video player"
1919
frameborder="0"
2020
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
@@ -49,6 +49,21 @@ The Port MCP Server directly enables these kinds of valuable, in-context interac
4949

5050
## Key capabilities and use-cases
5151

52+
<center>
53+
<div className="video-container">
54+
<iframe
55+
style={{borderRadius:'4px'}}
56+
width="568"
57+
height="320"
58+
src="https://www.youtube.com/embed/hxUTTPSApQs"
59+
title="YouTube video player"
60+
frameborder="0"
61+
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
62+
allowfullscreen>
63+
</iframe>
64+
</div>
65+
</center>
66+
5267
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:
5368

5469
### Find information quickly
@@ -97,6 +112,11 @@ Receive assistance with common development and operational tasks, directly withi
97112

98113
![Getting instructions for new service setup](/img/ai-agents/MCPClaudeServiceSetup.png)
99114

115+
### Find your own use cases
116+
117+
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"
118+
119+
100120
## Using Port MCP
101121

102122
### Setup

0 commit comments

Comments
 (0)