Skip to content

Commit 4d5f4a4

Browse files
authored
docs: Add quickstart to README (#4)
# Add Quickstart to README ## Changes - Added a quickstart section to README.md - Updated version reference in UV.lock
1 parent 3d1a31c commit 4d5f4a4

File tree

2 files changed

+52
-1
lines changed

2 files changed

+52
-1
lines changed

README.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
- [MCP Server](#mcp-server)
66
- [Table of contents](#table-of-contents)
77
- [Description](#description)
8+
- [Quickstart Guide](#quickstart-guide)
89
- [Available Tools](#available-tools)
910
- [Requirements](#requirements)
1011
- [UV Setup](#uv-setup)
@@ -25,6 +26,56 @@
2526

2627
This is an implementation of an [MCP (Model Context Protocol) Server](https://modelcontextprotocol.io/quickstart/server) to allow different LLMs to query information from Sysdig Secure platform. **It is still in early development and not yet ready for production use.** New endpoints and functionalities will be added over time. The goal is to provide a simple and easy-to-use interface for querying information from Sysdig Secure platform using LLMs.
2728

29+
## Quickstart Guide
30+
31+
Get up and running with the Sysdig MCP Server quickly using our pre-built Docker image.
32+
33+
1. **Get your API Token**:
34+
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 Secure platform (See the [Configuration](#configuration) section for more details).
35+
36+
2. **Pull the image**:
37+
38+
Pull the latest Sysdig MCP Server image from the GitHub Container Registry:
39+
40+
```bash
41+
docker pull ghcr.io/sysdiglabs/sysdig-mcp-server:latest
42+
```
43+
44+
3. **Configure your client**:
45+
46+
For example, you can configure Claude Desktop app to use the Sysdig MCP Server by editing the `claude_desktop_config.json` file. This is useful for running the server locally with the `stdio` transport. You can apply this configuration to any other client that supports MCP (For more details, see the [Client Configuration](#client-configuration) section).
47+
48+
Substitute the following placeholders with your actual values:
49+
- `<your_sysdig_host>`: The hostname of your Sysdig Secure instance (e.g., `https://us2.app.sysdig.com` or `https://eu1.app.sysdig.com`)
50+
- `<your_sysdig_secure_api_token>`: Your Sysdig Secure API token
51+
52+
```json
53+
{
54+
"mcpServers": {
55+
"sysdig-mcp-server": {
56+
"command": "docker",
57+
"args": [
58+
"run",
59+
"-i",
60+
"--rm",
61+
"-e",
62+
"SYSDIG_HOST",
63+
"-e",
64+
"MCP_TRANSPORT",
65+
"-e",
66+
"SYSDIG_SECURE_TOKEN",
67+
"ghcr.io/sysdiglabs/sysdig-mcp-server:latest"
68+
],
69+
"env": {
70+
"SYSDIG_HOST": "<your_sysdig_host>",
71+
"SYSDIG_SECURE_TOKEN": "<your_sysdig_secure_api_token>",
72+
"MCP_TRANSPORT": "stdio"
73+
}
74+
}
75+
}
76+
}
77+
```
78+
2879
## Available Tools
2980

3081
<details>

uv.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)