SigNoz MCP server for AI agents

The Signoz MCP Server provides an interface to access and analyze your Signoz observability data through the Model Context Protocol. It enables AI assistants and tools to fetch dashboard data, metrics, traces, logs, and execute custom queries against your Signoz instance.

Installation Options

Option 1: Local Installation with uv

Install Dependencies

uv venv .venv
source .venv/bin/activate
uv sync

Run the Server

uv run -m src.signoz_mcp_server.mcp_server

Option 2: Docker Compose (Recommended for Production)

Configure and Run

Edit src/signoz_mcp_server/config.yaml with your Signoz details
Start the server:

docker-compose up -d

Option 3: Manual Docker Setup

Build the Image

docker build -t signoz-mcp-server .

Run with Configuration File

docker run -d \
  -p 8000:8000 \
  -v $(pwd)/src/signoz_mcp_server/config.yaml:/app/config.yaml:ro \
  --name signoz-mcp-server \
  signoz-mcp-server

Run with Environment Variables

docker run -d \
  -p 8000:8000 \
  -e SIGNOZ_HOST="https://your-signoz-instance.com" \
  -e SIGNOZ_API_KEY="your-signoz-api-key-here" \
  -e SIGNOZ_SSL_VERIFY="true" \
  -e MCP_SERVER_PORT=8000 \
  -e MCP_SERVER_DEBUG=true \
  --name signoz-mcp-server \
  signoz-mcp-server

Configuration

The server can be configured using environment variables (recommended) or a YAML configuration file.

Environment Variables

SIGNOZ_HOST: Signoz instance URL (e.g., https://your-signoz-instance.com)
SIGNOZ_API_KEY: Signoz API key (optional)
SIGNOZ_SSL_VERIFY: true or false (default: true)
MCP_SERVER_PORT: Port to run the server on (default: 8000)
MCP_SERVER_DEBUG: true or false (default: true)

YAML Configuration File

signoz:
  host: "https://your-signoz-instance.com"
  api_key: "your-signoz-api-key-here" # Optional
  ssl_verify: "true"
server:
  port: 8000
  debug: true

Integration with AI Assistants

Local Setup Integration

Add this to your client configuration (e.g., claude-desktop.json):

{
  "mcpServers": {
    "signoz": {
      "command": "uv",
      "args": ["run", "/full/path/to/src/signoz_mcp_server/mcp_server.py"],
      "env": {
        "SIGNOZ_HOST": "https://your-signoz-instance.com",
        "SIGNOZ_API_KEY": "your-signoz-api-key-here",
        "SIGNOZ_SSL_VERIFY": "true"
      }
    }
  }
}

Docker Integration

{
  "mcpServers": {
    "signoz": {
      "command": "docker",
      "args": [
        "run",
        "--rm",
        "-i",
        "-e",
        "SIGNOZ_HOST",
        "-e",
        "SIGNOZ_API_KEY",
        "-e",
        "SIGNOZ_SSL_VERIFY",
        "signoz-mcp-server",
        "-t",
        "stdio"
      ],
      "env": {
        "SIGNOZ_HOST": "https://your-signoz-instance.com",
        "SIGNOZ_API_KEY": "your-signoz-api-key-here",
        "SIGNOZ_SSL_VERIFY": "true"
      }
    }
  }
}

HTTP/SSE Connection

If the MCP server is already running, connect directly to its HTTP endpoint:

mcpServers:
  signoz:
    url: "http://your-server-host:8000/mcp"

Available Tools

The MCP server provides access to the following capabilities:

test_connection: Verify connectivity to your Signoz instance
fetch_dashboards: List all available dashboards
fetch_dashboard_details: Get detailed information about a specific dashboard
fetch_dashboard_data: Fetch panel data for a dashboard by name and time range
fetch_apm_metrics: Retrieve APM metrics for a service
fetch_services: Get all instrumented services
execute_clickhouse_query: Run custom Clickhouse SQL queries
execute_builder_query: Execute Signoz builder queries
fetch_traces_or_logs: Fetch traces or logs using ClickHouse SQL

Health Check

The server provides a health check endpoint at:

http://localhost:8000/health

For additional help, join the Signoz community on Slack at this link and message in the #mcp channel.

How to install this MCP server

For Claude Code

To add this MCP server to Claude Code, run this command in your terminal:

claude mcp add-json "signoz" '{"command":"docker","args":["run","--rm","-i","-e","SIGNOZ_HOST","-e","SIGNOZ_API_KEY","-e","SIGNOZ_SSL_VERIFY","signoz-mcp-server","-t","stdio"],"env":{"SIGNOZ_HOST":"https://your-signoz-instance.com","SIGNOZ_API_KEY":"your-signoz-api-key-here","SIGNOZ_SSL_VERIFY":"true"}}'

See the official Claude Code MCP documentation for more details.

For Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > Tools & Integrations and click "New MCP Server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

{
    "mcpServers": {
        "signoz": {
            "command": "docker",
            "args": [
                "run",
                "--rm",
                "-i",
                "-e",
                "SIGNOZ_HOST",
                "-e",
                "SIGNOZ_API_KEY",
                "-e",
                "SIGNOZ_SSL_VERIFY",
                "signoz-mcp-server",
                "-t",
                "stdio"
            ],
            "env": {
                "SIGNOZ_HOST": "https://your-signoz-instance.com",
                "SIGNOZ_API_KEY": "your-signoz-api-key-here",
                "SIGNOZ_SSL_VERIFY": "true"
            }
        }
    }
}

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explicitly ask the agent to use the tool by mentioning the tool name and describing what the function does.

For Claude Desktop

To add this MCP server to Claude Desktop:

1. Find your configuration file:

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json
Linux: ~/.config/Claude/claude_desktop_config.json

2. Add this to your configuration file:

{
    "mcpServers": {
        "signoz": {
            "command": "docker",
            "args": [
                "run",
                "--rm",
                "-i",
                "-e",
                "SIGNOZ_HOST",
                "-e",
                "SIGNOZ_API_KEY",
                "-e",
                "SIGNOZ_SSL_VERIFY",
                "signoz-mcp-server",
                "-t",
                "stdio"
            ],
            "env": {
                "SIGNOZ_HOST": "https://your-signoz-instance.com",
                "SIGNOZ_API_KEY": "your-signoz-api-key-here",
                "SIGNOZ_SSL_VERIFY": "true"
            }
        }
    }
}

3. Restart Claude Desktop for the changes to take effect