Skip to content

Commit 9332d12

Browse files
authored
Merge pull request #2989 from port-labs/ai-docs-updates
AI docs updates
2 parents f225cfe + 4cb5c31 commit 9332d12

File tree

16 files changed

+279
-90
lines changed

16 files changed

+279
-90
lines changed

docs/ai-interfaces/AGENTS.md

Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
---
2+
sidebar_class_name: hidden
3+
title: AGENTS.md - AI Documentation Maintenance Guide
4+
---
5+
6+
# AGENTS.md - AI Documentation Maintenance Guide
7+
8+
This is a hidden guide for AI agents to understand how to maintain and update the AI interfaces documentation in Port Docs.
9+
10+
## File Structure
11+
12+
The AI interfaces documentation files are located in:
13+
- `/docs/ai-interfaces/` - Main documentation files
14+
- `/src/data/mcpTools.js` - MCP tool definitions (JSON file)
15+
- `/src/components/ToolsList/` - React component that displays tools from `mcpTools.js`
16+
17+
## Common Tasks
18+
19+
### Update MCP Tools
20+
21+
To add, update, or remove MCP tools:
22+
23+
1. **Update the file**: `src/data/mcpTools.js`
24+
2. **Ask for clarification**: Determine if the tool is for `builder` only or for both `developer` and `builder` roles
25+
3. The `ToolsList` component automatically reads from this file and displays tools in the documentation
26+
27+
### Set Feature Beta Status
28+
29+
When asked to mark a feature as **open beta** or **closed beta**, use the appropriate component:
30+
31+
#### For Open Beta Features
32+
33+
Use the `BetaFeatureNotice` component:
34+
35+
```markdown
36+
import BetaFeatureNotice from '/docs/generalTemplates/_beta_feature_notice.md'
37+
38+
<BetaFeatureNotice id="ai-form" />
39+
```
40+
41+
**Location**: Place this after the page title (H1) and before the main content.
42+
43+
#### For Closed Beta Features
44+
45+
Use the `ClosedBetaFeatureNotice` component:
46+
47+
```markdown
48+
import ClosedBetaFeatureNotice from '/docs/generalTemplates/_closed_beta_feature_notice.md'
49+
50+
<ClosedBetaFeatureNotice id="feature-id" />
51+
```
52+
53+
**Location**: Place this after the page title (H1) and before the main content.
54+
55+
**ID**: Use a specific feature identifier (e.g., `"slack-app"`). Check `/docs/generalTemplates/_closed_beta_feature_notice_defs.js` for available IDs and their custom messages. You might need to create a new definition, ask the user for this.
56+
57+
### Add New LLM Model
58+
59+
To add a new LLM model to the documentation:
60+
61+
1. **Identify the model name and providers**: Determine the exact model identifier (e.g., `gpt-5`) and which providers support it (e.g., Anthropic, AWS Bedrock).
62+
63+
2. **Update the main documentation file**: Edit `docs/ai-interfaces/port-ai/llm-providers-management/overview.md`:
64+
65+
3. **Note about API reference files**: The API reference files in `docs/api-reference/` (like `general-purpose-ai-interactions.api.mdx`, `invoke-a-specific-agent.api.mdx`, etc.) are auto-generated from OpenAPI specifications. These will be updated automatically when the backend API is updated. You don't need to manually edit these files.
66+
67+
### Update MCP Installation Instructions
68+
69+
The MCP installation instructions are maintained in a reusable component that is imported into the main documentation page.
70+
71+
**Location**: `/docs/generalTemplates/_mcp-installation.md`
72+
73+
**Usage**: This component is imported in `docs/ai-interfaces/port-mcp-server/overview-and-installation.md`.
74+
75+
**What you could update**:
76+
- Add new client support
77+
- Update client instructions
78+
- Update disclaimers/warnings/admonitions
79+
80+
### Update Feature Support Matrix
81+
82+
The Feature Support Matrix table shows which capabilities are supported across Port's AI interfaces.
83+
84+
**Location**: `docs/ai-interfaces/overview.md` - in the "Feature Support Matrix" section
85+
86+
**Structure**:
87+
- **Rows**: Each Port AI interface (Port MCP Server, Port AI Invocation, Port AI Agents, Port AI Chat Widget, Port Slack App, Port AI Assistant)
88+
- **Columns**: Capabilities/features (Context Lake Query, Run Actions, Manage Blueprints, etc.)
89+
- **Indicators**:
90+
- ✅ = Supported
91+
- ❌ = Not supported
92+
93+
**Column Ordering Rules**:
94+
1. **First columns**: Features that have at least one ✅ (supported by at least one interface)
95+
2. **Last columns**: Features that have all ❌ (not supported by any interface)
96+
3. **Final column**: "Manage Data Mapping" should always be the last column (it has all ❌)
97+
98+
**Current column order** (from first to last):
99+
1. Feature (row identifier)
100+
2. Context Lake Query
101+
3. Run Actions
102+
4. Manage Blueprints
103+
5. Manage Entities
104+
6. Manage Scorecards
105+
7. Manage Actions
106+
8. Reuse Prompts
107+
9. Invoke AI Agents
108+
10. Manage Pages & Widgets (all ❌)
109+
11. Manage Integrations (all ❌)
110+
12. Manage Data Mapping (all ❌ - must be last)
111+
112+
**When updating**:
113+
- If a new feature is added that has all ❌, add it before "Manage Data Mapping" (which must remain last)
114+
- If a feature's support status changes from all ❌ to having at least one ✅, move it to the appropriate position in the first group
115+
- If a new AI interface is added, add it as a new row
116+
- If a new capability is added, determine its position based on whether it has any ✅ or all ❌
117+
118+
**Format**:
119+
- Use markdown table format
120+
- Wrap the table in `<div style={{overflowX: 'auto'}}>` for horizontal scrolling on smaller screens
121+
- Use emojis ✅ and ❌ (not text symbols)
122+
123+
### Update Monthly Limits
124+
125+
When asked to update the monthly quota/limit for AI invocations:
126+
127+
1. **Identify all locations**: Search for mentions of monthly limits/quota in the AI interfaces documentation:
128+
- `docs/ai-interfaces/port-ai/api-interaction.md` - Contains rate limits section and example JSON responses
129+
- `docs/ai-interfaces/port-ai/overview.md` - Contains limits section and FAQ entries
130+
131+
2. **Update text descriptions**: Replace the quota number in all text descriptions (e.g., "20 AI invocations per month" → "50 AI invocations per month")
132+
133+
3. **Update example JSON**: Update the `monthlyLimit` value in example JSON responses to match the new limit. Also update `remainingQuota` to be one less than the limit (e.g., if limit is 50, remainingQuota should be 49)
134+
135+
4. **Files to check**:
136+
- `docs/ai-interfaces/port-ai/api-interaction.md` - Lines with "Monthly Quota" section and JSON examples
137+
- `docs/ai-interfaces/port-ai/overview.md` - Lines with "Monthly Quota" section and FAQ entries
138+
139+
5. **Search pattern**: Look for patterns like:
140+
- "20 AI invocations per month"
141+
- `"monthlyLimit": 20`
142+
- "Default quota: 20"
143+
144+
**Note**: The API reference files in `docs/api-reference/` are auto-generated from OpenAPI specifications and will be updated automatically when the backend API is updated. You don't need to manually edit these files.
145+
146+
## Other Tasks
147+
148+
For other tasks not listed above, ask for clarification from the user. Once understood, add a new section to the "Common Tasks" section of this file.

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

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,11 @@ title: Build an AI agent
55

66
# Build an AI agent
77

8-
:::info Closed Beta
9-
Port's AI offerings are currently in closed beta and will be gradually rolled out to users by the end of 2025.
10-
:::
11-
128
import Tabs from "@theme/Tabs"
139
import TabItem from "@theme/TabItem"
10+
import BetaFeatureNotice from '/docs/generalTemplates/_beta_feature_notice.md'
11+
12+
<BetaFeatureNotice id="ai-form" />
1413

1514
:::info Built on Port AI
1615
AI Agents are built on top of [Port AI](/ai-interfaces/port-ai/overview) and leverage its underlying capabilities for data access, security, and execution. This guide focuses on agent-specific building techniques.
@@ -118,7 +117,7 @@ From [john-123](https://github.com/john-123)
118117
<details>
119118
<summary><b>I don't see an option to add an AI agent (Click to expand)</b></summary>
120119

121-
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.
120+
Make sure you have [access to the AI agents feature](/ai-interfaces/ai-agents/overview#access-to-the-feature). If you believe you should have access, please contact our support.
122121
</details>
123122

124123
<details>

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

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,11 @@ title: Interact with AI agents
55

66
# Interact with AI agents
77

8-
:::info Closed Beta
9-
Port's AI offerings are currently in closed beta and will be gradually rolled out to users by the end of 2025.
10-
:::
11-
128
import Tabs from "@theme/Tabs"
139
import TabItem from "@theme/TabItem"
10+
import BetaFeatureNotice from '/docs/generalTemplates/_beta_feature_notice.md'
11+
12+
<BetaFeatureNotice id="ai-form" />
1413

1514
:::info Built on Port AI
1615
AI Agents are specialized implementations built on top of [Port AI](/ai-interfaces/port-ai/overview), designed for machine-to-machine communication and autonomous operations within defined domains.
@@ -54,6 +53,8 @@ The widget provides a chat interface where you can ask questions and receive res
5453

5554
The widget will inherit all the agent's configuration including the prompts, conversation starters, tool access, etc.
5655

56+
**Context Awareness**: The widget automatically understands the context of the page and entity where it's located. For example, when placed on a team entity page, you can ask questions like "What is this team's lead time for change?" or "How many open bugs does the team have?" without needing to specify the team name.
57+
5758
Conversation starters appear in the initial state, helping users understand what they can ask the agent. Users can either click a starter to begin a new chat or type their own question.
5859
<img src='/img/ai-agents/AIAgentsWidgetConversationStarters.png' width='80%' border='1px' />
5960

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

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,11 @@ title: Overview
66
import Tabs from "@theme/Tabs"
77
import TabItem from "@theme/TabItem"
88
import PortTooltip from "/src/components/tooltip/tooltip.jsx"
9-
import ClosedBetaFeatureNotice from '/docs/generalTemplates/_closed_beta_feature_notice.md'
9+
import BetaFeatureNotice from '/docs/generalTemplates/_beta_feature_notice.md'
1010

1111
# AI agents overview
1212

13-
:::info Closed Beta
14-
Port's AI offerings are currently in closed beta and will be gradually rolled out to users by the end of 2025.
15-
:::
13+
<BetaFeatureNotice id="ai-form" />
1614

1715
:::info Built on Port AI
1816
AI Agents are specialized implementations built on top of [Port AI](/ai-interfaces/port-ai/overview), designed for specific domains and machine-to-machine communication. For general AI capabilities and human interaction, see [Port AI](/ai-interfaces/port-ai/overview).

docs/ai-interfaces/ai-chat-widget.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ The AI Chat Widget is a dashboard component that:
2424
- **Uses configured tools**: Operates with the specific [Port AI tools](/ai-interfaces/port-ai/overview#port-ai-tools) you select.
2525
- **Customizable placement**: Can be embedded in any dashboard layout.
2626
- **Respects permissions**: Only accesses data based on user permissions.
27+
- **Context-aware**: Automatically understands the page and entity context where it's located, allowing you to ask questions about the specific entity or page without explicitly mentioning it.
2728

2829
## Widget Configuration
2930

@@ -82,6 +83,17 @@ Users can type their own questions and requests directly into the chat interface
8283
- Show visual indicators when tools are being used.
8384
- Provide links to relevant Port pages and actions.
8485

86+
### Context Awareness
87+
88+
The AI Chat Widget automatically understands the context of the page and entity where it's located. This means you can ask questions about the specific entity or page without needing to explicitly mention it.
89+
90+
**Examples:**
91+
- On a **team entity page**: "What is this team's lead time for change?" or "How many open bugs does the team have?"
92+
- On a **service entity page**: "What's the deployment status?" or "Show me recent incidents"
93+
- On a **dashboard**: Questions will be answered in the context of the dashboard's scope
94+
95+
The widget uses this context to provide more relevant and accurate responses, making it easier to get information about the specific entity or page you're viewing.
96+
8597
### Tool Transparency
8698
The widget interface provides enhanced capabilities and visual indicators showing which tools are being used:
8799

@@ -314,4 +326,17 @@ For comprehensive information, see [Security Considerations](#security-considera
314326
- [Data Privacy & Retention](/ai-interfaces/port-ai/security-and-data-controls#data-privacy--retention) - How your data is handled and stored.
315327
</details>
316328

329+
<details>
330+
<summary><b>Does the widget understand the context of the page it's on? (Click to expand)</b></summary>
331+
332+
Yes! The AI Chat Widget automatically understands the context of the page and entity where it's located. This means you can ask questions about the specific entity or page without needing to explicitly mention it.
333+
334+
**Examples:**
335+
- On a **team entity page**: "What is this team's lead time for change?" or "How many open bugs does the team have?"
336+
- On a **service entity page**: "What's the deployment status?" or "Show me recent incidents"
337+
- On a **dashboard**: Questions will be answered in the context of the dashboard's scope
338+
339+
The widget uses this context to provide more relevant and accurate responses. Learn more in [Context Awareness](#context-awareness).
340+
</details>
341+
317342
The AI Chat Widget provides a powerful way to bring [Port AI](/ai-interfaces/port-ai/overview) capabilities directly into your team's daily workflows through customized dashboard experiences.

docs/ai-interfaces/overview.md

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

66
# AI Interfaces Overview
77

8-
Port's AI interfaces provide intelligent assistance across your entire software development lifecycle. Our AI capabilities are currently in **open beta**, with Slack App in **closed beta**.
8+
Port's AI interfaces provide intelligent assistance across your entire software development lifecycle. All AI features are currently in **open beta**.
99

1010
We're committed to developing AI responsibly, maintaining high standards of data privacy and security. **[Learn more about our security & data controls →](/ai-interfaces/port-ai/security-and-data-controls)**
1111

@@ -82,7 +82,7 @@ The MCP Server provides AI machine interface capabilities that are compatible wi
8282
**[Set up MCP Server →](/ai-interfaces/port-mcp-server/overview-and-installation)**
8383

8484
### Slack App
85-
Interact with Port's AI capabilities directly from Slack. Ask questions, run actions, and get insights without leaving your team communication platform. **Currently in closed beta** - we are not accepting new applications at the moment and will update once it moves to open beta.
85+
Interact with Port's AI capabilities directly from Slack. Ask questions, run actions, and get insights without leaving your team communication platform.
8686

8787
**[Learn about the Slack App →](/ai-interfaces/slack-app)**
8888

@@ -100,6 +100,23 @@ Set up the **MCP Server** to bring Port's AI capabilities directly into your dev
100100
### For Team Collaboration
101101
Use the **Slack App** to make AI insights available to your entire team in your communication platform.
102102

103+
## Feature Support Matrix
104+
105+
The following table shows which capabilities are supported across Port's AI interfaces:
106+
107+
<div style={{overflowX: 'auto'}}>
108+
109+
| Feature | Context Lake Query | Run Actions | Manage Blueprints | Manage Entities | Manage Scorecards | Manage Actions | Reuse Prompts | Invoke AI Agents | Manage Pages & Widgets | Manage Integrations | Manage Data Mapping |
110+
|--------------------------------|-------------------|-------------------|-------------------|-------------------|-------------------|-------------------|-------------------|-------------------|-------------------|-------------------|-------------------|
111+
| **Port MCP Server** ||||||||||||
112+
| **Port AI Invocation** ||||||||||||
113+
| **Port AI Agents** ||||||||||||
114+
| **Port AI Chat Widget** ||||||||||||
115+
| **Port Slack App** ||||||||||||
116+
| **Port AI Assistant** ||||||||||||
117+
118+
</div>
119+
103120
## Frequently Asked Questions
104121

105122
<details>
@@ -109,7 +126,7 @@ Port offers four main AI interfaces:
109126
- **Port AI Assistant**: Chat interface for quick questions and insights.
110127
- **AI Agents**: Customizable workflows for automations.
111128
- **MCP Server**: IDE integration for development workflows.
112-
- **Slack App**: Team collaboration interface (closed beta).
129+
- **Slack App**: Team collaboration interface.
113130
</details>
114131

115132
<details>
@@ -129,7 +146,7 @@ If you're a developer who works primarily in an IDE, consider starting with the
129146

130147
For custom workflows or automation, explore **AI Agents**. **[Learn about AI Agents →](/ai-interfaces/ai-agents/overview)**
131148

132-
For team collaboration, try the **Slack App** to bring AI insights into your communication platform (closed beta). **[Explore Slack App →](/ai-interfaces/slack-app)**
149+
For team collaboration, try the **Slack App** to bring AI insights into your communication platform. **[Explore Slack App →](/ai-interfaces/slack-app)**
133150
</details>
134151

135152
<details>
@@ -138,7 +155,7 @@ For team collaboration, try the **Slack App** to bring AI insights into your com
138155
- **Port AI Assistant**: Open beta - available to all users.
139156
- **MCP Server**: Open beta - available to all users.
140157
- **AI Agents**: Open beta - available to all users.
141-
- **Slack App**: Closed beta - not accepting new applications at the moment.
158+
- **Slack App**: Open beta - available to all users.
142159
</details>
143160

144161
<details>

0 commit comments

Comments
 (0)