Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/pages/docs/octopus-ai/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,9 @@ The Assistant also helps monitor your Octopus Deploy instance for optimization o

### Octopus MCP Server

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

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.

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

Expand Down
4 changes: 4 additions & 0 deletions src/pages/docs/octopus-ai/mcp/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ The Octopus MCP Server works by communicating with your Octopus instance's REST

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

## Governance

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.

## 🚀 Installation

### Requirements
Expand Down
6 changes: 2 additions & 4 deletions src/pages/docs/octopus-rest-api/how-to-create-an-api-key.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,9 @@ After you generate an API key, it cannot be retrieved from the Octopus Web Porta

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.

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.
You can also create an agent API key directly from the **API Keys** page:

You can also create an agent API key directly from the **Manage API Keys** page:

1. Click **New Agent Key** and state the purpose of the key.
1. Click **New API key for AI Agent** and state the purpose of the key.
1. Choose the level of **Access** to grant.
1. Click **Generate new**.
1. Copy the new API key to your clipboard.
Expand Down
4 changes: 2 additions & 2 deletions src/pages/docs/security/users-and-teams/service-accounts.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ When using Octopus Deploy it is common to have other automated services control
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.

:::div{.hint}
**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.
**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.

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).
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).
:::

## Creating a service account {#ServiceAccounts-CreatingAServiceAccount}
Expand Down
Loading