Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
e1e58c7
docs(DOCS-395): document AI security features
harrison-akeyless May 12, 2026
ce3cda8
chore: remove lychee ignore additions from PR
harrison-akeyless May 12, 2026
54b1b19
chore: change lychee hook stage from pre-commit to manual
harrison-akeyless May 12, 2026
cac6fcb
docs: update Agentic Runtime Authority documentation for clarity and …
harrison-akeyless May 12, 2026
2390ee5
Refactor MCP documentation and add integration guides
harrison-akeyless May 12, 2026
2d46e15
docs: enhance clarity in Agentic Runtime Authority documentation
harrison-akeyless May 12, 2026
8a18ea6
docs: add additional MCP integration documentation links
harrison-akeyless May 12, 2026
cbb89d5
docs: enhance prompt injection protection documentation with addition…
harrison-akeyless May 12, 2026
25cb02f
docs: add MCP Server documentation link to AI Insights guide
harrison-akeyless May 12, 2026
ed7de3e
docs: add links to CLI commands in Agentic Runtime Authority document…
harrison-akeyless May 12, 2026
de04083
docs: add CLI reference links for MCP commands to enhance usage clarity
harrison-akeyless May 12, 2026
5a3dab8
docs: add MCP and runtime authority command documentation for enhance…
harrison-akeyless May 12, 2026
a6838d2
docs: update Identity & Secrets Intelligence documentation to remove …
harrison-akeyless May 12, 2026
40cbd4a
docs: update authentication examples in MCP documentation for clarity
harrison-akeyless May 12, 2026
f3fff9b
docs: streamline MCP documentation by removing redundant sections and…
harrison-akeyless May 12, 2026
c9bad8b
docs: enhance MCP command documentation with clearer headings and int…
harrison-akeyless May 12, 2026
f50edcf
docs: correct file paths and enhance section headings for clarity in …
harrison-akeyless May 12, 2026
62f03bf
docs: add AI Security and Secure Remote Access documentation with str…
harrison-akeyless May 12, 2026
9b277c9
docs: address AI security review comments and constraints
harrison-akeyless May 12, 2026
f20cd93
Merge branch 'v1.0' into v1.0_docs-395-agentic-runtime-authority-isi
harrison-akeyless May 12, 2026
645cbc9
Update docs/AI Security/MCP/index.md
harrison-akeyless May 14, 2026
da4455e
merge v1.0 and address Eldad review feedback
harrison-akeyless May 14, 2026
98c7733
docs: expand ISI operational views and monitoring workflow
harrison-akeyless May 14, 2026
d136c00
docs: make mcp secret-name optional in ARA setup
harrison-akeyless May 14, 2026
7d831dd
docs: add explicit ARA policy and traceability summary
harrison-akeyless May 14, 2026
c9e161f
DOCS-395: Update Agentic Runtime Authority documentation with policy …
harrison-akeyless May 14, 2026
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: 4 additions & 0 deletions .other/redirects-backup.txt
Original file line number Diff line number Diff line change
Expand Up @@ -835,3 +835,7 @@
/v2/docs/remote-access-desktop-application-beta -> /docs/sra-desktop-application-beta
/docs/copy-of-remote-access-on-k8s -> /docs/sra-setup-k8s
/v2/docs/copy-of-remote-access-on-k8s -> /docs/sra-setup-k8s
/docs/akeyless-mcp-model-context-protocol-command -> /docs/mcp-server
/v2/docs/akeyless-mcp-model-context-protocol-command -> /docs/mcp-server
/docs/akeyless-mcp-plugin-jetbrains-ides -> /docs/mcp-jetbrains-ides
/v2/docs/akeyless-mcp-plugin-jetbrains-ides -> /docs/mcp-jetbrains-ides
5 changes: 5 additions & 0 deletions docs/AI Security/MCP/_order.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
- index
- mcp-claude-desktop
- mcp-cursor
- mcp-github-copilot
- mcp-jetbrains-ides
72 changes: 72 additions & 0 deletions docs/AI Security/MCP/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
title: MCP Server
excerpt: Overview of Akeyless MCP content, requirements, and supported integrations.
deprecated: false
hidden: false
link:
new_tab: false
metadata:
title: Akeyless MCP Server
description: Overview of Akeyless MCP content, requirements, and supported integrations.
robots: index
---
The Akeyless Model Context Protocol (MCP) Server lets MCP-enabled tools connect to your Akeyless identity security platform through the Akeyless CLI or Gateway. This section explains the MCP server, its command syntax, and the supported client integrations documented by Akeyless.

Model Context Protocol (MCP) is an open protocol that standardizes how an AI client discovers tools and sends tool calls to an external server. In this model, your MCP client (for example, Claude Desktop, Cursor, or GitHub Copilot) launches the Akeyless MCP server locally over `stdio`, then uses it to run authorized operations against Akeyless resources.

## Common Requirements

All documented MCP integrations share these requirements:

* Akeyless CLI version `1.130.0` or later.
* An Akeyless account and a configured CLI profile, or explicit authentication flags.
* A Gateway URL passed directly in the client configuration or command arguments.
* A client that can launch the Akeyless MCP server over `stdio`.

Read more about the [Model Context Protocol](https://modelcontextprotocol.io/).

## General MCP Usage Flow

Use this high-level flow for any supported MCP integration:

1. Install and configure the Akeyless CLI and authentication profile.
2. Configure your MCP client to run the Akeyless MCP server command.
3. Start or reload the MCP client so it discovers the Akeyless tools.
4. Invoke Akeyless tools from the client prompt and review the response.
5. Use RBAC and scoped secret permissions to control what the client can access.

## MCP-Related CLI Commands

The Akeyless CLI currently exposes two MCP-related commands:

| Command | Purpose |
| --- | --- |
| `akeyless mcp` | Starts the general Akeyless MCP server for standard Akeyless tools. |
| `akeyless mcp-runtime-authority` | Starts the Agentic Runtime Authority MCP server for runtime query workflows (`list-secrets`, `query-db`, `service-execute`). |

For full command flags and usage details, see [CLI Reference](https://docs.akeyless.io/docs/cli-reference#mcp).

### Command: akeyless mcp

The `akeyless mcp` command starts an MCP server so AI assistants can securely interact with Akeyless services through a standardized interface. It accepts the same authentication flags as other Akeyless CLI commands. For details, see [Access and Authentication Methods](https://docs.akeyless.io/docs/access-and-authentication-methods).

> Important: `akeyless mcp` does not use the `gateway_url` value configured in a CLI profile. You must pass `--gateway-url` directly in every `akeyless mcp` command (or MCP client args).

For full command syntax and flags, see [CLI Reference - mcp](https://docs.akeyless.io/docs/cli-reference#mcp).

### Command: akeyless mcp-runtime-authority

The `akeyless mcp-runtime-authority` command starts the MCP server for Agentic Runtime Authority runtime-query tools (`list-secrets`, `query-db`, `service-execute`). It uses the same authentication model as `akeyless mcp`, and accepts an optional `--secret-name` flag to set a default secret path for `query-db`.

For full command syntax and flags, see [CLI Reference - mcp-runtime-authority](https://docs.akeyless.io/docs/cli-reference#mcp-runtime-authority).

For Runtime Authority behavior, prerequisites, and tool semantics, see [Agentic Runtime Authority](https://docs.akeyless.io/docs/agentic-runtime-authority).

## Supported Integrations

| Integration | Primary use case | Configuration surface |
| --- | --- | --- |
| [Claude Desktop](https://docs.akeyless.io/docs/mcp-claude-desktop) | Desktop AI assistant workflow with local MCP client configuration | `~/Library/Application Support/Claude/claude_desktop_config.json` |
| [Cursor](https://docs.akeyless.io/docs/mcp-cursor) | Editor-based MCP workflow in Cursor | `~/.cursor/mcp.json` or Cursor settings JSON |
| [GitHub Copilot](https://docs.akeyless.io/docs/mcp-github-copilot) | MCP workflow with GitHub Copilot CLI | `~/.copilot/mcp-config.json` |
| [JetBrains IDEs](https://docs.akeyless.io/docs/mcp-jetbrains-ides) | IDE-native plugin workflow for JetBrains products | JetBrains plugin settings |
88 changes: 88 additions & 0 deletions docs/AI Security/MCP/mcp-claude-desktop.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
---
title: Claude Desktop
slug: mcp-claude-desktop
excerpt: Connect Claude Desktop to the Akeyless MCP Server.
deprecated: false
hidden: false
metadata:
title: ''
description: ''
robots: index
---
Connect Claude Desktop to the Akeyless Model Context Protocol (MCP) Server when you want Claude Desktop to access Akeyless tools through MCP.

For general MCP background and command syntax, see [MCP Server](https://docs.akeyless.io/docs/mcp-server).

## Requirements

* Akeyless CLI version `1.130.0` or later.
* A configured Akeyless profile, or the authentication values required by your chosen access type.
* A Gateway URL passed directly in the client configuration.

## Configure Claude Desktop

1. Install and configure the Akeyless CLI.
2. Edit `~/Library/Application Support/Claude/claude_desktop_config.json`.
3. Add the Akeyless MCP server configuration.
4. Restart Claude Desktop.

The following examples show common authentication configurations:

```json Default
{
"mcpServers": {
"akeyless": {
"command": "akeyless",
"args": [
"mcp",
"--profile", "<profile-name>",
"--gateway-url", "https://<your-gateway-url>:8000/api/v2"
]
}
}
}
```
```json SAML
{
"mcpServers": {
"akeyless-saml": {
"command": "akeyless",
"args": [
"mcp",
"--access-id", "<access-id>",
"--access-type", "saml",
"--gateway-url", "https://<your-gateway-url>:8000/api/v2"
]
}
}
}
```
```json OIDC
{
"mcpServers": {
"akeyless-oidc": {
"command": "akeyless",
"args": [
"mcp",
"--access-id", "<access-id>",
"--access-type", "oidc",
"--gateway-url", "https://<your-gateway-url>:8000/api/v2"
]
}
}
}
```

## Verify The Integration

After Claude Desktop restarts, verify that Claude can run MCP-backed requests such as:

* "Show me my Akeyless secrets"
* "List all my targets"
* "Create a new secret called `api-key`"

## Notes

* The Akeyless CLI serves MCP over `stdio`, so Claude Desktop must invoke the `akeyless mcp` command directly.
* When `--profile` is used, the saved CLI profile supplies the authentication settings.
* Pass `--gateway-url` directly in the Claude Desktop configuration even when the profile already has a saved Gateway value.
88 changes: 88 additions & 0 deletions docs/AI Security/MCP/mcp-cursor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
---
title: Cursor
slug: mcp-cursor
excerpt: Connect Cursor to the Akeyless MCP Server.
deprecated: false
hidden: false
metadata:
title: ''
description: ''
robots: index
---
Connect Cursor to the Akeyless MCP Server when you want MCP access inside the Cursor editor.

For general MCP background and command syntax, see [MCP Server](https://docs.akeyless.io/docs/mcp-server).

## Requirements

* Akeyless CLI version `1.130.0` or later.
* A configured Akeyless profile, or the authentication values required by your chosen access type.
* A Gateway URL passed directly in the client configuration.

## Configure Cursor

1. Install and configure the Akeyless CLI.
2. Open Cursor settings JSON.
3. Add the Akeyless MCP server configuration.
4. Restart Cursor.

The following examples show common authentication configurations:

```json Default
{
"mcpServers": {
"akeyless": {
"command": "akeyless",
"args": [
"mcp",
"--profile", "<profile-name>",
"--gateway-url", "https://<your-gateway-url>:8000/api/v2"
]
}
}
}
```
```json SAML
{
"mcpServers": {
"akeyless-saml": {
"command": "akeyless",
"args": [
"mcp",
"--access-id", "<access-id>",
"--access-type", "saml",
"--gateway-url", "https://<your-gateway-url>:8000/api/v2"
]
}
}
}
```
```json OIDC
{
"mcpServers": {
"akeyless-oidc": {
"command": "akeyless",
"args": [
"mcp",
"--access-id", "<access-id>",
"--access-type", "oidc",
"--gateway-url", "https://<your-gateway-url>:8000/api/v2"
]
}
}
}
```

## Verify The Integration

After Cursor restarts, verify that Cursor can run MCP-backed requests such as:

* "Show me my Akeyless secrets"
* "Create a new secret called `api-key`"
* "List all my targets"

## Notes

* The Akeyless CLI serves MCP over `stdio`, so Cursor must invoke the `akeyless mcp` command directly.
* When `--profile` is used, the saved CLI profile supplies the authentication settings.
* Pass `--gateway-url` directly in the Cursor configuration even when the profile already has a saved Gateway value.
101 changes: 101 additions & 0 deletions docs/AI Security/MCP/mcp-github-copilot.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
---
title: GitHub Copilot
slug: mcp-github-copilot
excerpt: Connect GitHub Copilot to the Akeyless MCP Server.
deprecated: false
hidden: false
metadata:
title: ''
description: ''
robots: index
---
Connect GitHub Copilot to the Akeyless MCP Server when you want Copilot to access Akeyless tools through MCP.

For general MCP background and command syntax, see [MCP Server](https://docs.akeyless.io/docs/mcp-server).

## Requirements

* Akeyless CLI version `1.130.0` or later.
* GitHub Copilot CLI installed.
* A configured Akeyless profile, or the authentication values required by your chosen access type.
* A Gateway URL passed directly in the client configuration.

## Install GitHub Copilot CLI

```shell
npm install -g @githubnext/github-copilot-cli
```

## Configure GitHub Copilot

1. Install and configure the Akeyless CLI.
2. Edit `~/.copilot/mcp-config.json`.
3. Add the Akeyless MCP server configuration.
4. Start GitHub Copilot with MCP enabled.

The following examples show common authentication configurations:

```json Default
{
"mcpServers": {
"akeyless": {
"command": "akeyless",
"args": [
"mcp",
"--profile", "<profile-name>",
"--gateway-url", "https://<your-gateway-url>:8000/api/v2"
]
}
}
}
```
```json SAML
{
"mcpServers": {
"akeyless-saml": {
"command": "akeyless",
"args": [
"mcp",
"--access-id", "<access-id>",
"--access-type", "saml",
"--gateway-url", "https://<your-gateway-url>:8000/api/v2"
]
}
}
}
```
```json OIDC
{
"mcpServers": {
"akeyless-oidc": {
"command": "akeyless",
"args": [
"mcp",
"--access-id", "<access-id>",
"--access-type", "oidc",
"--gateway-url", "https://<your-gateway-url>:8000/api/v2"
]
}
}
}
```

Start Copilot with MCP:

```shell
copilot mcp
```

## Verify The Integration

After GitHub Copilot starts with MCP enabled, verify that it can run MCP-backed requests such as:

* "Show me my Akeyless secrets"
* "List all my targets"
* "Create a new secret called `api-key`"

## Notes

* The Akeyless CLI serves MCP over `stdio`, so GitHub Copilot must invoke the `akeyless mcp` command directly.
* When `--profile` is used, the saved CLI profile supplies the authentication settings.
* Pass `--gateway-url` directly in the Copilot configuration even when the profile already has a saved Gateway value.
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Akeyless MCP Plugin for JetBrains IDEs
slug: mcp-jetbrains-ides
excerpt: Integrate Akeyless secrets management directly into JetBrains IDEs with MCP
deprecated: false
hidden: false
Expand Down Expand Up @@ -113,10 +114,12 @@ For profile details and advanced options, see [CLI Profiles](https://docs.akeyle

Note that the project uses a JDK 17 compile toolchain. If the Gradle wrapper fails to start because the default Java version is too new, set `org.gradle.java.home` in `gradle.properties` to a JDK 17 or JDK 21 installation.

Install the generated plugin from disk:

1. In your JetBrains IDE, go to **Settings → Plugins**.
1. Select the gear icon, and then select **Install Plugin from Disk...**.
1. Select the generated ZIP file from the `build/distributions/` directory.
1. Restart the IDE when prompted.
2. Select the gear icon, and then select **Install Plugin from Disk...**.
3. Select the generated ZIP file from the `build/distributions/` directory.
4. Restart the IDE when prompted.
Comment thread
coderabbitai[bot] marked this conversation as resolved.

### Step 4: Configure the Plugin

Expand Down
6 changes: 4 additions & 2 deletions docs/AI/_order.yaml → docs/AI Security/_order.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
- ai-security
- akeyless-ai-insight
- prompt-injection-protection-for-ai-agents
- MCP
- identity-and-secrets-intelligence
- agentic-runtime-authority
- MCP
- prompt-injection-protection-for-ai-agents
Loading
Loading