Signoz MCP Server

A Go implementation of a Model Context Protocol (MCP) server that provides seamless integration with SigNoz, an open-source observability platform. This server enables AI assistants and other MCP clients to interact with SigNoz APIs for querying dashboards, metrics, traces, logs, and more.

Features

The Signoz MCP Server provides the following tools:

• signoz_test_connection: Verify connectivity to your Signoz instance and configuration
• signoz_fetch_dashboards: List all available dashboards from Signoz
• signoz_fetch_dashboard_details: Retrieve detailed information about a specific dashboard by its ID
• signoz_fetch_dashboard_data: Fetch all panel data for a given dashboard by name and time range
• signoz_fetch_apm_metrics: Retrieve standard APM metrics (request rate, error rate, latency, apdex) for a given service and time range
• signoz_fetch_services: Fetch all instrumented services from Signoz with optional time range filtering
• signoz_execute_clickhouse_query: Execute custom ClickHouse SQL queries via the Signoz API with time range support
• signoz_execute_builder_query: Execute Signoz builder queries for custom metrics and aggregations with time range support
• signoz_fetch_traces_or_logs: Fetch traces or logs from SigNoz using ClickHouse SQL

Architecture

This project follows Clean Architecture principles with the following structure:

├── cmd/server/              # Application entry point
├── internal/
│   ├── domain/              # Domain models and interfaces
│   ├── application/service/ # Application services
│   └── infrastructure/      # External integrations
│       ├── config/          # Configuration management
│       └── signoz/          # Signoz API client
├── pkg/mcp/                 # MCP protocol implementation
│   ├── transport/           # Transport layer (STDIO)
│   └── server/              # MCP server implementation
└── configs/                 # Configuration files

Prerequisites

• Go 1.22 or later
• Access to a SigNoz instance
• SigNoz API key (if authentication is required)

Installation

Option 1: Build from Source

1. Clone the repository:

git clone https://github.com/CalmoAI/mcp-server-signoz.git
cd signoz-mcp-server

2. Install and update dependencies:

go mod tidy

3. Build the server:

go build -o signoz-mcp-server ./cmd/server

4. (Optional) Get the absolute path for configuration:

pwd
# This will show the full path to your binary: /path/to/signoz-mcp-server

5. Verify the installation:

# Test that the binary runs (it will start the MCP server)
./signoz-mcp-server
# Press Ctrl+C to stop the server

Option 2: Install with Go

go install github.com/CalmoAI/mcp-server-signoz/cmd/server@latest

Configuration

The server can be configured using environment variables, configuration files, or command-line flags.

Environment Variables

ANY configuration value can be overridden using environment variables with the SIGNOZ_MCP_ prefix. This provides complete flexibility for deployment and runtime configuration.

Environment Variable Pattern

SIGNOZ_MCP_<SECTION>_<KEY>

Examples

# Core SigNoz configuration
export SIGNOZ_MCP_SIGNOZ_URL="https://your-signoz-instance.com"
export SIGNOZ_MCP_SIGNOZ_API_KEY="your-api-key"

# Logging configuration  
export SIGNOZ_MCP_LOG_LEVEL="debug"
export SIGNOZ_MCP_LOG_FORMAT="text"

# Server configuration
export SIGNOZ_MCP_SERVER_TIMEOUT="60s"
export SIGNOZ_MCP_SERVER_DEBUG="true"

# Telemetry configuration
export SIGNOZ_MCP_TELEMETRY_ENABLED="false"

Complete Environment Variable Reference

Server Configuration:

• SIGNOZ_MCP_SERVER_NAME - Server name (default: "signoz-mcp-server")
• SIGNOZ_MCP_SERVER_VERSION - Server version (default: "1.0.0")
• SIGNOZ_MCP_SERVER_ENVIRONMENT - Environment (default: "development")

... View full README on GitHub