Skip to content

Commit b339047

Browse files
authored
Merge pull request #3234 from ginatkins/update-agent-governance-copy
Refine agent governance copy and cross-linking
2 parents f411d05 + daa1378 commit b339047

4 files changed

Lines changed: 11 additions & 7 deletions

File tree

src/pages/docs/octopus-ai/index.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,9 @@ The Assistant also helps monitor your Octopus Deploy instance for optimization o
3535

3636
### Octopus MCP Server
3737

38-
The Octopus MCP ([Model Context Protocol](https://modelcontextprotocol.io/)) server represents a significant leap forward in AI integration capabilities. Built on Anthropic's open standard for connecting AI assistants to external data sources and tools, the MCP server will enable AI assistants like Claude to interact directly with your Octopus Deploy infrastructure.
38+
The Octopus MCP (Model Context Protocol) server represents a significant leap forward in AI integration capabilities. Built on Anthropic's open standard for connecting AI agents to external data sources and tools, the MCP server will enable AI agents like Claude to interact directly with your Octopus Deploy infrastructure.
39+
40+
With supporting **governance** features like [Agent API keys](/docs/octopus-rest-api/how-to-create-an-api-key#creating-an-agent-api-key) and [Agent Service Accounts](/docs/security/users-and-teams/service-accounts#agent-service-accounts), you can also keep agent actions fully auditable in clear, filterable audit logs, so you can meet your compliance requirements.
3941

4042
The Octopus MCP server provides similar capabilities to the Octopus AI Assistant, but provides further benefits:
4143

src/pages/docs/octopus-ai/mcp/index.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,10 @@ The Octopus MCP Server works by communicating with your Octopus instance's REST
3030

3131
To learn more, read our [Octopus REST API](/docs/octopus-rest-api) documentation.
3232

33+
## Governance
34+
35+
Use dedicated [Agent API keys](/docs/octopus-rest-api/how-to-create-an-api-key#creating-an-agent-api-key) and [Agent Service Accounts](/docs/security/users-and-teams/service-accounts#agent-service-accounts) for agents connecting to your Octopus instance. These keep agent actions fully auditable in clear, filterable audit logs, so you can meet your compliance requirements.
36+
3337
## 🚀 Installation
3438

3539
### Requirements

src/pages/docs/octopus-rest-api/how-to-create-an-api-key.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,9 @@ After you generate an API key, it cannot be retrieved from the Octopus Web Porta
3333

3434
If you're connecting an AI agent to Octopus—such as the [Octopus MCP server](/docs/octopus-ai/mcp)—create a dedicated agent API key rather than a regular one. Agent keys are tagged throughout Octopus so you can filter for and audit agent activity separately from human activity.
3535

36-
The recommended approach is to first create an [Agent Service Account](/docs/security/users-and-teams/service-accounts#agent-service-accounts) for your agent. Any API key created under an agent service account is automatically tagged as an agent key.
36+
You can also create an agent API key directly from the **API Keys** page:
3737

38-
You can also create an agent API key directly from the **Manage API Keys** page:
39-
40-
1. Click **New Agent Key** and state the purpose of the key.
38+
1. Click **New API key for AI Agent** and state the purpose of the key.
4139
1. Choose the level of **Access** to grant.
4240
1. Click **Generate new**.
4341
1. Copy the new API key to your clipboard.

src/pages/docs/security/users-and-teams/service-accounts.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ When using Octopus Deploy it is common to have other automated services control
1616
It is best to create **Service accounts** for this purpose to provide each service with the least privileges required for the tasks each service will perform.
1717

1818
:::div{.hint}
19-
**Service accounts** are **API-only accounts** that can be assigned permissions in the same way you do for normal user accounts, but are prevented from using the Octopus Web Portal.
19+
**Service accounts** are **API-only accounts** that can be assigned permissions in the same way you do for normal accounts, but are prevented from using the Octopus Web Portal.
2020

21-
Service accounts authenticate with the Octopus API using [OpenID Connect](/docs/octopus-rest-api/openid-connect) or an [Octopus API Key](/docs/octopus-rest-api/how-to-create-an-api-key).
21+
Service accounts authenticate with the Octopus API using [OpenID Connect](/docs/octopus-rest-api/openid-connect) or an [Octopus API Key](/docs/octopus-rest-api/how-to-create-an-api-key). For dedicated agent service accounts, see [Agent service accounts](/docs/security/users-and-teams/service-accounts#agent-service-accounts).
2222
:::
2323

2424
## Creating a service account {#ServiceAccounts-CreatingAServiceAccount}

0 commit comments

Comments
 (0)