Skip to content

Commit 1939af0

Browse files
authored
docs: clarify API token can be Secure or Monitor (#78)
Either a Sysdig Secure or Monitor API token works against `SYSDIG_MCP_API_TOKEN`. README prose and placeholder (`<your_sysdig_secure_api_token>` → `<your_sysdig_api_token>`) previously implied Secure-only.
1 parent f95c8ae commit 1939af0

1 file changed

Lines changed: 20 additions & 20 deletions

File tree

README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -35,15 +35,15 @@ This is an implementation of an [MCP (Model Context Protocol) Server](https://mo
3535
Get up and running with the Sysdig MCP Server quickly using our pre-built Docker image.
3636

3737
1. **Get your API Token**:
38-
Go to your Sysdig Secure instance and navigate to **Settings > Sysdig Secure API**. Here, you can generate or copy your API token. This token is required to authenticate requests to the Sysdig Platform (See the [Configuration](#configuration) section for more details).
38+
Go to your Sysdig instance and navigate to **Settings > Sysdig Secure API** (or **Sysdig Monitor API**). Either a Sysdig Secure or Sysdig Monitor API token works. This token is required to authenticate requests to the Sysdig Platform (See the [Configuration](#configuration) section for more details).
3939

4040
2. **Configure your MCP client**:
4141

4242
Add the server configuration to your MCP client (e.g., Claude Desktop's `claude_desktop_config.json`). Choose your preferred installation method from the [Server Setup](#server-setup) section. The [Docker](#docker) method is the easiest to get started with since it requires no local toolchain.
4343

4444
Substitute the following placeholders with your actual values:
45-
- `<your_sysdig_host>`: The hostname of your Sysdig Secure instance (e.g., `https://us2.app.sysdig.com` or `https://eu1.app.sysdig.com`)
46-
- `<your_sysdig_secure_api_token>`: Your Sysdig Secure API token
45+
- `<your_sysdig_host>`: The hostname of your Sysdig instance (e.g., `https://us2.app.sysdig.com` or `https://eu1.app.sysdig.com`)
46+
- `<your_sysdig_api_token>`: Your Sysdig API token (Secure or Monitor)
4747

4848
## Available Tools
4949

@@ -168,8 +168,8 @@ The server dynamically filters the available tools based on the permissions asso
168168

169169
The following environment variables are **required** for configuring the Sysdig SDK:
170170

171-
- `SYSDIG_MCP_API_HOST`: The URL of your Sysdig Secure instance (e.g., `https://us2.app.sysdig.com`). **Required when using `stdio` transport.**
172-
- `SYSDIG_MCP_API_TOKEN`: Your Sysdig Secure API token. **Required only when using `stdio` transport.**
171+
- `SYSDIG_MCP_API_HOST`: The URL of your Sysdig instance (e.g., `https://us2.app.sysdig.com`). **Required when using `stdio` transport.**
172+
- `SYSDIG_MCP_API_TOKEN`: Your Sysdig API token (Secure or Monitor). **Required only when using `stdio` transport.**
173173

174174
You can also set the following variables to override the default configuration:
175175

@@ -181,7 +181,7 @@ You can also set the following variables to override the default configuration:
181181
- `SYSDIG_MCP_LISTENING_HOST`: The host for the server when it is deployed using remote protocols (`streamable-http`, `sse`). Defaults to all interfaces (`:port`). Set to `127.0.0.1` for local-only access.
182182
- `SYSDIG_MCP_STATELESS`: Enable stateless mode for `streamable-http` transport, where each request is self-contained with no session tracking (useful for AWS Bedrock AgentCore). Defaults to: `false`.
183183

184-
You can find your API token in the Sysdig Secure UI under **Settings > Sysdig Secure API**. Make sure to copy the token as it will not be shown again.
184+
You can find your API token in the Sysdig UI under **Settings > Sysdig Secure API** (or **Sysdig Monitor API**). Make sure to copy the token as it will not be shown again.
185185

186186
![API_TOKEN_CONFIG](./docs/assets/settings-config-token.png)
187187
![API_TOKEN_SETTINGS](./docs/assets/api-token-copy.png)
@@ -267,7 +267,7 @@ If you have Go installed, the MCP client can run the server directly without clo
267267
],
268268
"env": {
269269
"SYSDIG_MCP_API_HOST": "<your_sysdig_host>",
270-
"SYSDIG_MCP_API_TOKEN": "<your_sysdig_secure_api_token>",
270+
"SYSDIG_MCP_API_TOKEN": "<your_sysdig_api_token>",
271271
"SYSDIG_MCP_TRANSPORT": "stdio"
272272
}
273273
}
@@ -281,21 +281,21 @@ Or using the CLI:
281281
# Claude Code
282282
claude mcp add --transport stdio \
283283
-e SYSDIG_MCP_API_HOST=<your_sysdig_host> \
284-
-e SYSDIG_MCP_API_TOKEN=<your_sysdig_secure_api_token> \
284+
-e SYSDIG_MCP_API_TOKEN=<your_sysdig_api_token> \
285285
-e SYSDIG_MCP_TRANSPORT=stdio \
286286
-- sysdig-mcp-server go run github.com/sysdiglabs/sysdig-mcp-server/cmd/server@latest
287287

288288
# Gemini CLI
289289
gemini mcp add -t stdio \
290290
-e SYSDIG_MCP_API_HOST=<your_sysdig_host> \
291-
-e SYSDIG_MCP_API_TOKEN=<your_sysdig_secure_api_token> \
291+
-e SYSDIG_MCP_API_TOKEN=<your_sysdig_api_token> \
292292
-e SYSDIG_MCP_TRANSPORT=stdio \
293293
sysdig-mcp-server go run github.com/sysdiglabs/sysdig-mcp-server/cmd/server@latest
294294

295295
# Codex CLI
296296
codex mcp add \
297297
--env SYSDIG_MCP_API_HOST=<your_sysdig_host> \
298-
--env SYSDIG_MCP_API_TOKEN=<your_sysdig_secure_api_token> \
298+
--env SYSDIG_MCP_API_TOKEN=<your_sysdig_api_token> \
299299
--env SYSDIG_MCP_TRANSPORT=stdio \
300300
-- sysdig-mcp-server go run github.com/sysdiglabs/sysdig-mcp-server/cmd/server@latest
301301
```
@@ -329,7 +329,7 @@ Configure your client with:
329329
],
330330
"env": {
331331
"SYSDIG_MCP_API_HOST": "<your_sysdig_host>",
332-
"SYSDIG_MCP_API_TOKEN": "<your_sysdig_secure_api_token>",
332+
"SYSDIG_MCP_API_TOKEN": "<your_sysdig_api_token>",
333333
"SYSDIG_MCP_TRANSPORT": "stdio"
334334
}
335335
}
@@ -368,7 +368,7 @@ Configure your client with:
368368
"command": "sysdig-mcp-server",
369369
"env": {
370370
"SYSDIG_MCP_API_HOST": "<your_sysdig_host>",
371-
"SYSDIG_MCP_API_TOKEN": "<your_sysdig_secure_api_token>",
371+
"SYSDIG_MCP_API_TOKEN": "<your_sysdig_api_token>",
372372
"SYSDIG_MCP_TRANSPORT": "stdio"
373373
}
374374
}
@@ -382,21 +382,21 @@ Or using the CLI:
382382
# Claude Code
383383
claude mcp add --transport stdio \
384384
-e SYSDIG_MCP_API_HOST=<your_sysdig_host> \
385-
-e SYSDIG_MCP_API_TOKEN=<your_sysdig_secure_api_token> \
385+
-e SYSDIG_MCP_API_TOKEN=<your_sysdig_api_token> \
386386
-e SYSDIG_MCP_TRANSPORT=stdio \
387387
-- sysdig-mcp-server sysdig-mcp-server
388388

389389
# Gemini CLI
390390
gemini mcp add -t stdio \
391391
-e SYSDIG_MCP_API_HOST=<your_sysdig_host> \
392-
-e SYSDIG_MCP_API_TOKEN=<your_sysdig_secure_api_token> \
392+
-e SYSDIG_MCP_API_TOKEN=<your_sysdig_api_token> \
393393
-e SYSDIG_MCP_TRANSPORT=stdio \
394394
sysdig-mcp-server sysdig-mcp-server
395395

396396
# Codex CLI
397397
codex mcp add \
398398
--env SYSDIG_MCP_API_HOST=<your_sysdig_host> \
399-
--env SYSDIG_MCP_API_TOKEN=<your_sysdig_secure_api_token> \
399+
--env SYSDIG_MCP_API_TOKEN=<your_sysdig_api_token> \
400400
--env SYSDIG_MCP_TRANSPORT=stdio \
401401
-- sysdig-mcp-server sysdig-mcp-server
402402
```
@@ -413,7 +413,7 @@ kubectl create namespace mcp-server
413413
kubectl create secret generic mcp-server-secrets \
414414
--namespace mcp-server \
415415
--from-literal=SYSDIG_MCP_API_HOST=<your_sysdig_host> \
416-
--from-literal=SYSDIG_MCP_API_TOKEN=<your_sysdig_secure_api_token>
416+
--from-literal=SYSDIG_MCP_API_TOKEN=<your_sysdig_api_token>
417417
```
418418

419419
**2. Deploy the server:**
@@ -487,16 +487,16 @@ To use the MCP server with a client like Claude or Cursor, you need to provide t
487487

488488
### Authentication
489489

490-
When using the `sse` or `streamable-http` transport, the server requires a Bearer token for authentication. The token is passed in the `X-Sysdig-Token` or default to `Authorization` header of the HTTP request (i.e `Bearer SYSDIG_SECURE_API_TOKEN`).
490+
When using the `sse` or `streamable-http` transport, the server requires a Bearer token for authentication. The token is passed in the `X-Sysdig-Token` or default to `Authorization` header of the HTTP request (i.e `Bearer SYSDIG_MCP_API_TOKEN`).
491491

492-
Additionally, you can specify the Sysdig Secure host by providing the `X-Sysdig-Host` header.
492+
Additionally, you can specify the Sysdig host by providing the `X-Sysdig-Host` header.
493493

494494
> **Note:** When provided, the authentication headers (`Authorization`, `X-Sysdig-Token`) and host header (`X-Sysdig-Host`) take precedence over the configured environment variables.
495495

496496
Example headers:
497497

498498
```
499-
Authorization: Bearer <your_sysdig_secure_api_token>
499+
Authorization: Bearer <your_sysdig_api_token>
500500
X-Sysdig-Host: <your_sysdig_host>
501501
```
502502

@@ -513,7 +513,7 @@ For the Claude Desktop app, configure the MCP server by editing the `claude_desk
513513
1. Go to **Settings > Developer** in the Claude Desktop app.
514514
2. Click on **Edit Config** to open the `claude_desktop_config.json` file.
515515
3. Add the JSON configuration from the [Server Setup](#server-setup) section that matches your installation method (Go, Docker, or Binary).
516-
4. Replace `<your_sysdig_host>` with your Sysdig Secure host URL and `<your_sysdig_secure_api_token>` with your API token.
516+
4. Replace `<your_sysdig_host>` with your Sysdig host URL and `<your_sysdig_api_token>` with your Sysdig Secure or Monitor API token.
517517
5. Save the file and restart the Claude Desktop app.
518518

519519
**Connecting to a Remote Server:**

0 commit comments

Comments
 (0)