You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-44Lines changed: 13 additions & 44 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,6 @@
17
17
-[Requirements](#requirements)
18
18
-[UV Setup](#uv-setup)
19
19
-[Configuration](#configuration)
20
-
-[`app_config.yaml`](#app_configyaml)
21
20
-[Environment Variables](#environment-variables)
22
21
-[Running the Server](#running-the-server)
23
22
-[Docker](#docker)
@@ -85,21 +84,6 @@ Get up and running with the Sysdig MCP Server quickly using our pre-built Docker
85
84
86
85
## Available Tools
87
86
88
-
You can selectwhat group of tools to add when running the server by adding/removing them from the `mcp.allowed_tools` list in the app_config.yaml file
89
-
90
-
```yaml
91
-
...
92
-
mcp:
93
-
transport: stdio
94
-
...
95
-
allowed_tools:
96
-
- "events-feed"
97
-
- "inventory"
98
-
- "vulnerability-management"
99
-
- "sysdig-sage"
100
-
- "sysdig-cli-scanner"# Only available in stdio local transport mode
101
-
```
102
-
103
87
<details>
104
88
<summary><strong>Events Feed</strong></summary>
105
89
@@ -168,13 +152,9 @@ mcp:
168
152
169
153
You can use [uv](https://github.com/astral-sh/uv) as a drop-in replacement for pip to create the virtual environment and install dependencies.
170
154
171
-
If you don't have `uv` installed, you can install it via (Linux and MacOS users):
155
+
If you don't have `uv` installed, you can install it following the instructions that you can find on the `README` of the project.
172
156
173
-
```bash
174
-
curl -Ls https://astral.sh/uv/install.sh | sh
175
-
```
176
-
177
-
To set up the environment:
157
+
If you want to develop, set up the environment using:
178
158
179
159
```bash
180
160
uv venv
@@ -185,36 +165,26 @@ This will create a virtual environment using `uv` and install the required depen
185
165
186
166
## Configuration
187
167
188
-
The application can be configured via the `app_config.yaml` file and environment variables.
189
-
190
-
### `app_config.yaml`
191
-
192
-
This file contains the main configuration for the application, including:
193
-
194
-
- **app**: Host, port, and log level for the MCP server.
195
-
- **sysdig**: The Sysdig Secure host to connect to.
196
-
- **mcp**: Transport protocol (stdio, sse, streamable-http), URL, host, and port for the MCP server.
197
-
198
-
> You can set the path for the app_config.yaml using the `APP_CONFIG_FILE=/path/to/app_config.yaml` env var. By default the app will search the file in the root of the app.
199
-
200
-
### Environment Variables
201
-
202
-
The following environment variables are required for configuring the Sysdig SDK:
168
+
The following environment variables are **required** for configuring the Sysdig SDK:
203
169
204
170
- `SYSDIG_HOST`: The URL of your Sysdig Secure instance (e.g., `https://us2.app.sysdig.com`).
205
171
- `SYSDIG_SECURE_TOKEN`: Your Sysdig Secure API token.
206
172
173
+
You can also set the following variables to override the default configuration:
174
+
175
+
- `SYSDIG_MCP_TRANSPORT`: The transport protocol for the MCP Server (`stdio`, `streamable-http`, `sse`). Defaults to: `stdio`.
176
+
- `SYSDIG_MCP_MOUNT_PATH`: The URL prefix for the Streamable-http/sse deployment. Defaults to: `/sysdig-mcp-server`
177
+
- `LOGLEVEL`: Log Level of the application (`DEBUG`, `INFO`, `WARNING`, `ERROR`). Defaults to: `INFO`
178
+
- `SYSDIG_MCP_LISTENING_PORT`: The port for the server when it is deployed using remote protocols (`steamable-http`, `sse`). Defaults to: `8080`
179
+
- `SYSDIG_MCP_LISTENING_HOST`: The host for the server when it is deployed using remote protocols (`steamable-http`, `sse`). Defaults to: `localhost`
180
+
207
181
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.
@@ -312,7 +281,7 @@ To use the MCP server with a client like Claude or Cursor, you need to provide t
312
281
313
282
When using the `sse` or `streamable-http` transport, the server requires a Bearer token forauthentication. The token is passedin the `Authorization` header of the HTTP request.
314
283
315
-
Additionally, you can specify the Sysdig Secure host by providing the `X-Sysdig-Host` header. If this header is not present, the server will use the value from `app_config.yaml`.
284
+
Additionally, you can specify the Sysdig Secure host by providing the `X-Sysdig-Host` header. If this header is not present, the server will use the value from the env variable.
If you are running the server with the `sse` or `streamable-http` transport, the URL will be `http://<host>:<port>/sysdig-mcp-server/mcp`, where `<host>` and `<port>` are the values configured in`app_config.yaml` or the Docker run command.
295
+
If you are running the server with the `sse` or `streamable-http` transport, the URL will be `http://<host>:<port>/sysdig-mcp-server/mcp`.
327
296
328
297
For example, if you are running the server locally on port 8080, the URL will be `http://localhost:8080/sysdig-mcp-server/mcp`.
0 commit comments