Skip to content

Commit f7f0a09

Browse files
authored
Merge branch 'main' into PORT-streamline-iac-with-ai
2 parents f5201f5 + 8fa573b commit f7f0a09

File tree

45 files changed

+1987
-374
lines changed

Some content is hidden

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

45 files changed

+1987
-374
lines changed

docs/actions-and-automations/setup-backend/webhook/port-execution-agent/usage.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,8 @@ Use the following Helm values:
8888
- Set `selfSignedCertificate.enabled` to `true`.
8989
- Put your PEM-encoded CA content in `selfSignedCertificate.certificate`.
9090

91+
The certificate should be mounted to `/usr/local/share/ca-certificates/`.
92+
9193
`REQUESTS_CA_BUNDLE` is an environment variable used to specify a custom Certificate Authority (CA) bundle for verifying SSL/TLS certificates in HTTPS requests.
9294

9395
Set `REQUESTS_CA_BUNDLE` to the file path of your CA bundle, which should contain one or more CA certificates in PEM format.
@@ -103,10 +105,11 @@ This configuration directs the `requests` library to use the specified CA bundle
103105

104106
Use the following Helm values:
105107
- Keep your certificate via `selfSignedCertificate` as above.
106-
- Add other certificates by supplying files via `extraVolumes` and mounting them with `extraVolumeMounts` into the container.
108+
- Add other certificates by supplying files via `extraVolumes` and mounting them with `extraVolumeMounts` into the container at `/usr/local/share/ca-certificates/<your-cert-name>.crt`.
107109

108-
:::info Certificate file requirement
109-
Each certificate must be provided in a separate PEM file. Files containing multiple certificates are not supported.
110+
:::info Certificate file requirements
111+
- Each certificate must be provided in a separate PEM file. Files containing multiple certificates are not supported.
112+
- Certificates must be mounted to `/usr/local/share/ca-certificates/` with a `.crt` file extension.
110113
:::
111114

112115
## Next Steps
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
22
"label": "AI agents",
3-
"position": 4
3+
"position": 5
44
}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 3
2+
sidebar_position: 4
33
title: AI Chat Widget
44
sidebar_class_name: hidden
55
---

docs/ai-interfaces/overview.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,23 @@ The foundational AI infrastructure that powers all intelligent responses within
2222
**[Learn more about Port AI →](/ai-interfaces/port-ai/overview)**
2323

2424
### Port AI Assistant
25-
The fastest way to get started with Port's AI capabilities. A chat interface that provides instant answers about your SDLC.
25+
The fastest way to get started with Port's AI capabilities. An out-of-the-box chat interface available through a floating button that requires zero configuration.
2626

27-
**Use Port AI Assistant to ask:**
27+
**Use Port AI Assistant to:**
28+
* Ask questions about your software catalog and actions.
29+
* Get help with Port features and documentation.
30+
* Execute actions with approval mode safety.
31+
* Explore your data without complex queries.
32+
33+
**Example questions:**
2834
* "Which services are failing security checks?"
29-
* "When was the last successful deployment of the payment service?"
35+
* "How do I deploy the auth service to production?"
36+
* "Give me a weekly summary of open bugs"
3037
* "Who owns this component?"
31-
* "What's the deployment frequency of team X?"
3238

33-
Perfect for developers who need quick insights and contextual information about their development environment.
39+
Perfect for immediate insights without dedicated customizations. No agents, no configuration - just start asking questions.
40+
41+
**[Learn more about Port AI Assistant →](/ai-interfaces/port-ai-assistant)**
3442

3543

3644
### AI Agents
@@ -99,15 +107,15 @@ Port offers four main AI interfaces:
99107
<details>
100108
<summary>What's the difference between Port AI Assistant and AI Agents? (Click to expand)</summary>
101109

102-
**Port AI Assistant** is designed for immediate, ad-hoc questions and provides instant answers about your development environment. It's perfect for quick insights and exploratory queries.
110+
**Port AI Assistant** is designed for immediate use with zero configuration. It provides instant answers about your development environment through a floating chat button. It's perfect for quick insights, exploratory queries, and learning about Port. **[Learn more →](/ai-interfaces/port-ai-assistant)**
103111

104-
**AI Agents** are pre-configured, customizable entities designed for specific workflows and automations. They're built for machine-to-machine interactions and complex, domain-specific processes.
112+
**AI Agents** are customizable entities designed for specific workflows and automations. They're built for machine-to-machine interactions and complex, domain-specific processes that require dedicated configuration. **[Learn more →](/ai-interfaces/ai-agents/overview)**
105113
</details>
106114

107115
<details>
108116
<summary>Which AI interface should I start with? (Click to expand)</summary>
109117

110-
For most users, start with **Port AI Assistant** - it provides immediate value with no setup required. You can ask questions and get insights right away. **[Get started with Port AI Assistant →](/ai-interfaces/port-ai/overview)**
118+
For most users, start with **Port AI Assistant** - it provides immediate value with no setup required. Available through a floating button, you can ask questions and get insights right away. **[Get started with Port AI Assistant →](/ai-interfaces/port-ai-assistant)**
111119

112120
If you're a developer who works primarily in an IDE, consider starting with the **MCP Server** for seamless integration with your development workflow. **[Set up MCP Server →](/ai-interfaces/port-mcp-server/overview-and-installation)**
113121

@@ -119,7 +127,7 @@ For team collaboration, try the **Slack App** to bring AI insights into your com
119127
<details>
120128
<summary>What's the current availability status of Port's AI features? (Click to expand)</summary>
121129

122-
- **Port AI Assistant**: Open beta - available to all users.
130+
- **Port AI Assistant**: Closed beta - gradually rolling out to users.
123131
- **MCP Server**: Open beta - available to all users.
124132
- **AI Agents**: Closed beta - requires application and approval.
125133
- **Slack App**: Closed beta - requires application and approval.
Lines changed: 200 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,200 @@
1+
---
2+
sidebar_position: 2
3+
title: Port AI Assistant
4+
---
5+
6+
# Port AI Assistant
7+
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+
12+
The Port AI Assistant is the fastest way to start using AI with Port - no configuration required. Available through a floating chat button, it provides instant, intelligent answers about your software catalog, actions, and Port's capabilities.
13+
14+
## What is the Port AI Assistant?
15+
16+
The Port AI Assistant is an out-of-the-box chat interface that:
17+
18+
- **Requires no setup**: Start asking questions immediately without defining agents or configurations.
19+
- **Always accessible**: Available through a floating button whenever you have access to Port AI.
20+
- **Comprehensive knowledge**: Understands your catalog, actions, and Port documentation.
21+
- **Safe by default**: Uses read-only [MCP tools](/ai-interfaces/port-mcp-server/available-tools) and approval mode for actions.
22+
- **Fastest experience**: Get answers without the customization overhead of [AI Agents](/ai-interfaces/ai-agents/overview).
23+
24+
Built on [Port AI](/ai-interfaces/port-ai/overview), the assistant operates using [Port AI's developer tools](/ai-interfaces/port-ai/overview#port-ai-tools) in safe mode - meaning all actions run in **approval mode** (you get a link to review and execute) and uses read-only tools for data queries. The assistant also has access to Port's documentation through a dedicated MCP tool.
25+
26+
## How to Use the Port AI Assistant
27+
28+
The Port AI Assistant is available through a floating chat button in the Port interface. Simply click the button at the bottom-right corner to open the chat interface and start asking questions.
29+
30+
<img src='/img/ai-agents/AIChatInitialState.png' width='70%' border='1px' />
31+
32+
Once you ask a question, the assistant analyzes your request and uses the appropriate tools to provide a comprehensive response.
33+
34+
<img src='/img/ai-agents/AIChatAskQuestion.png' width='40%' border='1px' />
35+
36+
After processing your request, you'll receive a detailed answer along with any relevant actions or next steps.
37+
38+
<img src='/img/ai-agents/AIChatFinalResponse.png' width='40%' border='1px' />
39+
40+
## Example Questions
41+
42+
The Port AI Assistant can help with a wide variety of questions out of the box:
43+
44+
<details>
45+
<summary><b>Service Ownership & Information</b></summary>
46+
47+
- "Who owns the payment service?"
48+
- "What services does the platform team own?"
49+
- "Show me all microservices owned by the Backend team"
50+
- "What is the checkout service about?"
51+
- "What are the dependencies of the OrderProcessing service?"
52+
53+
</details>
54+
55+
<details>
56+
<summary><b>Deployment & Operations</b></summary>
57+
58+
- "How do I deploy the auth service to production?"
59+
- "When was the last successful deployment of the payment service?"
60+
- "Show me failed deployments from last week"
61+
- "What's deployed in production today?"
62+
- "What's the deployment frequency of team X?"
63+
64+
</details>
65+
66+
<details>
67+
<summary><b>Quality & Compliance</b></summary>
68+
69+
- "Which services are failing security checks?"
70+
- "Give me a weekly summary of open bugs"
71+
- "What's preventing the InventoryService from reaching Gold level?"
72+
- "Show me services with high bug counts"
73+
- "What's our overall security score?"
74+
75+
</details>
76+
77+
<details>
78+
<summary><b>Incidents & Monitoring</b></summary>
79+
80+
- "Show me active incidents"
81+
- "Which services had an incident in the last 30 days?"
82+
- "Who is on call for the payment service?"
83+
- "What is our mean time to resolution?"
84+
85+
</details>
86+
87+
<details>
88+
<summary><b>Tasks & Workflow</b></summary>
89+
90+
- "What tasks are assigned to me?"
91+
- "Show me my urgent Jira tickets"
92+
- "How many issues were closed by the frontend team this month?"
93+
- "What PRs are waiting for my review?"
94+
95+
</details>
96+
97+
<details>
98+
<summary><b>Port Usage & Help</b></summary>
99+
100+
- "How do I create a new blueprint?"
101+
- "What's the best way to set up scorecards?"
102+
- "How can I trigger an action via API?"
103+
- "Show me how to configure RBAC permissions"
104+
105+
</details>
106+
107+
108+
## Security & Permissions
109+
110+
The Port AI Assistant respects your organization's security controls:
111+
112+
- **RBAC compliance**: Only accesses data you have permissions to view.
113+
- **Safe operation**: Read-only tools for data queries.
114+
- **Action approval**: All actions require your explicit approval before execution.
115+
- **Audit trail**: All interactions are logged as [AI invocations](/ai-interfaces/port-ai/overview#ai-invocations).
116+
- **Access control**: Access to the Port AI Assistant is controlled through the `_ai_invocation` blueprint permissions. Learn more about [controlling access to Port AI](/ai-interfaces/port-ai/overview#controlling-access-to-port-ai).
117+
118+
For comprehensive security information, see [AI Security and Data Controls](/ai-interfaces/port-ai/security-and-data-controls).
119+
120+
## Frequently Asked Questions
121+
122+
<details>
123+
<summary><b>Do I need to configure anything to use the Port AI Assistant? (Click to expand)</b></summary>
124+
125+
No! The Port AI Assistant works out of the box. As soon as you have access to Port AI, you can start asking questions through the floating chat button. No setup, no configuration, no agent definitions required.
126+
127+
</details>
128+
129+
<details>
130+
<summary><b>Can the Port AI Assistant run actions on my behalf? (Click to expand)</b></summary>
131+
132+
The assistant can help you execute actions, but it operates in **approval mode**. This means:
133+
1. It will identify the right action for your request
134+
2. It will populate the action parameters based on context
135+
3. It will provide you a link to review and complete the action
136+
4. You maintain full control over execution
137+
138+
This approach ensures safety while making actions easier to discover and use.
139+
140+
</details>
141+
142+
<details>
143+
<summary><b>What's the difference between Port AI Assistant and AI Agents? (Click to expand)</b></summary>
144+
145+
**Port AI Assistant** is designed for:
146+
- Immediate use with zero configuration
147+
- General-purpose questions across your entire catalog
148+
- Interactive exploration and ad-hoc queries
149+
- Human interaction and learning
150+
151+
**[AI Agents](/ai-interfaces/ai-agents/overview)** are designed for:
152+
- Domain-specific expertise and workflows
153+
- Machine-to-machine communication
154+
- Autonomous operations and automations
155+
- Customized behavior for specific use cases
156+
157+
The assistant is the fastest way to get started, while agents provide advanced customization for specialized needs.
158+
159+
</details>
160+
161+
<details>
162+
<summary><b>What data can the Port AI Assistant access? (Click to expand)</b></summary>
163+
164+
The assistant uses [Port AI's developer tools](/ai-interfaces/port-ai/overview#port-ai-tools), which include read-only access to your data model, entities, scorecards, self-service actions, and Port documentation. All data access respects your organization's RBAC policies - you can only access data you have permissions to view. Learn more about [Port AI's security controls](/ai-interfaces/port-ai/security-and-data-controls).
165+
166+
</details>
167+
168+
<details>
169+
<summary><b>Can the Port AI Assistant help me learn how to use Port? (Click to expand)</b></summary>
170+
171+
Yes! The assistant has comprehensive knowledge of Port's documentation and can help you:
172+
- Understand how features work
173+
- Learn best practices
174+
- Troubleshoot issues
175+
- Discover new capabilities
176+
177+
Try asking questions like "How do I create a blueprint?" or "What's the best way to set up scorecards?"
178+
179+
</details>
180+
181+
<details>
182+
<summary><b>When should I use the Port AI Assistant vs other AI interfaces? (Click to expand)</b></summary>
183+
184+
**Use the Port AI Assistant** when you want immediate AI access with zero configuration. It's perfect for quick questions, exploratory queries, learning Port, and ad-hoc analysis.
185+
186+
**Use AI Chat Widgets** (with [AI Agents](/ai-interfaces/ai-agents/overview)) when you need customized AI experiences embedded in dashboards - configure prompts, conversation starters, and specific tool selections for team-specific workflows.
187+
188+
**Use AI Agents** for domain-specific expertise, machine-to-machine communication, and autonomous operations that require advanced customization.
189+
190+
</details>
191+
192+
<details>
193+
<summary><b>Are there usage limits for the Port AI Assistant? (Click to expand)</b></summary>
194+
195+
Yes, the Port AI Assistant uses the same [usage limits as Port AI](/ai-interfaces/port-ai/overview#limits-and-usage). These limits are at the organization level and include hourly rate limits and monthly quotas.
196+
197+
Monitor your usage through [AI invocations](/ai-interfaces/port-ai/overview#ai-invocations) in your Port catalog.
198+
199+
</details>
200+
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
22
"label": "Port AI",
3-
"position": 2
3+
"position": 3
44
}

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

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ For detailed information about tool selection patterns, API usage examples, and
9595
Port AI can be accessed through several interfaces, each designed for different use cases:
9696

9797
### Port AI Assistant
98-
The **Port AI Assistant** provides a dedicated, out-of-the-box user experience that requires no configuration. It offers a complete chat interface optimized for interacting with your Port data. *(Coming soon - comprehensive documentation)*
98+
The **[Port AI Assistant](/ai-interfaces/port-ai-assistant)** provides a dedicated, out-of-the-box user experience that requires no configuration. Available through a floating button, it offers instant access to AI-powered insights about your catalog, actions, and Port documentation - with zero setup required.
9999

100100
### AI Chat Widget
101101
The [AI Chat Widget](/ai-interfaces/ai-chat-widget) is a customizable interface that platform engineers can embed in dashboards. It allows configuration of:
@@ -183,6 +183,24 @@ Port AI respects your organization's security controls:
183183

184184
For detailed security information, see [AI Security and Data Controls](/ai-interfaces/port-ai/security-and-data-controls).
185185

186+
### Controlling Access to Port AI
187+
188+
Access to Port AI is controlled through the `_ai_invocation` blueprint's permissions. Users who have permission to **register** new AI invocation entities will be able to access and use Port AI interfaces, including the Port AI Assistant.
189+
190+
To configure who can access Port AI:
191+
192+
1. Navigate to your **Data Model** in Port
193+
2. Search for the `_ai_invocation` blueprint
194+
3. Go to the **Permissions** tab
195+
4. Under the **Entities** section, configure the **Register** permission
196+
5. Only users with the "register" permission will have access to Port AI
197+
198+
<img src='/img/ai-agents/AIInvocationPermissions.png' width='85%' border='1px' />
199+
200+
:::tip User access control
201+
By controlling who can register AI invocations, you can manage which users in your organization have access to Port AI features. This includes access to the Port AI Assistant, AI Chat Widgets, and API-based interactions.
202+
:::
203+
186204
## Technical Limitations
187205

188206
:::tip MCP Tools Limitations
@@ -277,7 +295,7 @@ Port AI supports two primary interaction types:
277295
<summary><b>How can I interact with Port AI? (Click to expand)</b></summary>
278296

279297
You can interact with Port AI through multiple interfaces:
280-
- **Port AI Assistant** - Dedicated chat interface *(documentation coming soon)*
298+
- **[Port AI Assistant](/ai-interfaces/port-ai-assistant)** - Out-of-the-box chat interface via floating button (no configuration required).
281299
- [AI Chat Widget](/ai-interfaces/ai-chat-widget) - Customizable dashboard widgets
282300
- API integration - For custom applications and external workflows
283301
- [AI Agents](/ai-interfaces/ai-agents/overview) - Specialized implementations built on Port AI
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
22
"label": "MCP server",
3-
"position": 4
3+
"position": 6
44
}

docs/ai-interfaces/slack-app.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 6
2+
sidebar_position: 7
33
title: Slack App
44
---
55

0 commit comments

Comments
 (0)