Signoz MCP Server

🚀 Signoz MCP Server

このサーバーは、Signozインスタンスとのやり取りを容易にするためのツール群を提供します。以下のデモ動画をご覧ください。 📽️ https://youtube.com/shorts/jxjmGyXXz7A

✨ 主な機能

MCPサーバーを介して利用可能なツールは以下の通りです。

• test_connection：Signozインスタンスへの接続と設定の検証を行います。
• fetch_dashboards：Signozから利用可能なすべてのダッシュボードを一覧表示します。
• fetch_dashboard_details：IDを指定して特定のダッシュボードの詳細情報を取得します。この情報にはダッシュボードのメタデータが含まれ、ライブのパネルデータは含まれません。
• fetch_dashboard_data：指定したダッシュボードの名前と時間範囲に基づいて、すべてのパネルデータを取得します。
• fetch_apm_metrics：指定したサービスと時間範囲に対する標準的なAPMメトリクス（リクエスト率、エラー率、レイテンシー、Apdexなど）を取得します。
• fetch_services：オプションで時間範囲を指定して、Signozからすべての計装されたサービスを取得します。
• execute_clickhouse_query：時間範囲をサポートしたSignoz APIを介して、カスタムのClickHouse SQLクエリを実行します。
• execute_builder_query：時間範囲をサポートしたカスタムメトリクスと集計のためのSignozビルダークエリを実行します。
• fetch_traces_or_logs：ClickHouse SQLを使用してSigNozからトレースまたはログを取得します。data_type（'traces'または'logs'）、時間範囲、サービス名、および取得件数を指定します。トレースまたはログの表形式の結果を返します。

🚀 クイックスタート

1. Signoz APIエンドポイントと（オプション）APIキーの取得

1. 稼働中のSignozインスタンス（セルフホストまたはクラウド）を用意してください。
2. （オプション）SignozインスタンスのヘルスエンドポイントにAPIキーが必要な場合、Signoz UIから生成または取得してください。

📦 インストール

2A. uvを使用したインストールと実行（ローカル開発に推奨）

2A.1. uvを使用して依存関係をインストールする

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

2A.2. uvを使用してサーバーを実行する

uv run -m src.signoz_mcp_server.mcp_server

• 必要に応じて、他のエントリーポイントスクリプトをuvで実行することもできます。
• config.yamlがmcp_server.pyと同じディレクトリにあることを確認するか、必要な環境変数を設定してください（設定のセクションを参照）。

2B. Docker Composeを使用した実行（本番環境/コンテナ環境に推奨）

1. src/signoz_mcp_server/config.yamlを編集し、Signozの詳細情報（ホスト、必要に応じてAPIキー）を設定します。
2. サーバーを起動します。

   docker-compose up -d
   

   • サーバーはデフォルトでポート8000でHTTP（SSE）モードで実行されます。
   • 環境変数を使用して設定を上書きすることができます（以下を参照）。

🔧 設定

サーバーは以下の優先順位で設定を読み込みます。

1. 環境変数（Docker/CIに推奨）:
   • SIGNOZ_HOST: SignozインスタンスのURL（例: https://your-signoz-instance.com）
   • SIGNOZ_API_KEY: Signoz APIキー（オプション）
   • SIGNOZ_SSL_VERIFY: trueまたはfalse（デフォルト: true）
   • MCP_SERVER_PORT: サーバーを実行するポート（デフォルト: 8000）
   • MCP_SERVER_DEBUG: trueまたはfalse（デフォルト: true）
2. YAMLファイルのフォールバック (config.yaml):

   signoz:
     host: "https://your-signoz-instance.com"
     api_key: "your-signoz-api-key-here" # オプション
     ssl_verify: "true"
   server:
     port: 8000
     debug: true
   

💻 使用例

AIアシスタントとの統合（例: Claude Desktop、Cursor）

このMCPサーバーは、MCPプロトコルをサポートする任意のツールと統合することができます。主なオプションは以下の通りです。

4A. ローカルセットアップ（uvを使用）

サーバーをローカルで実行する前に、依存関係をインストールしてuvで実行します。

uv sync

次に、クライアントの設定（例: claude-desktop.json）に追加します。

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

• uvのパスは、MacOS/Linuxではwhich uv、Windowsではwhere uvを実行することで確認できます。
• config.yamlがmcp_server.pyと同じディレクトリにあることを確認するか、パスを適宜更新してください。

4B. Docker ComposeまたはDockerを使用（環境変数、mcp-grafanaスタイル）

{
  "mcpServers": {
    "signoz": {
      "command": "docker",
      "args": [
        "run",
        "--rm",
        "-i",
        "-e",
        "SIGNOZ_HOST",
        "-e",
        "SIGNOZ_API_KEY",
        "-e",
        "SIGNOZ_SSL_VERIFY",
        "ddroid/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"
      }
    }
  }
}

• -t stdio引数は、Docker MCPクライアントとの互換性のためにサポートされています（stdioハンドシェイクモードを強制します）。
• デプロイに合わせて、ボリュームパスまたは環境変数を適宜調整してください。

4C. 既に稼働中のMCPサーバーへの接続（HTTP/SSE）

既にMCPサーバーが稼働している場合（例: リモートホスト、クラウドVM、またはKubernetes）、AIアシスタントまたはツールをそのHTTPエンドポイントに直接接続することができます。

例: Claude Desktopまたは同様のツール

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

• your-server-hostを、MCPサーバーが実行されている実際のホストに置き換えてください。
• ローカルセットアップの場合は、サーバーホストとしてlocalhostを使用します（つまり、http://localhost:8000/mcp）。
• ローカルまたはセキュリティが設定されていないデプロイではhttpを、本番環境またはセキュリティが設定されたデプロイではhttpsを使用してください。
• サーバーがクライアントマシンからアクセス可能であることを確認してください（ファイアウォール、セキュリティグループなどを確認）。

例: MCP設定YAML

mcp:
  endpoint: "http://your-server-host:8000/mcp"
  protocolVersion: "2025-06-18"

• your-server-hostを、MCPサーバーが実行されている実際のホストに置き換えてください。
• ローカルセットアップの場合は、サーバーホストとしてlocalhostを使用します（つまり、http://localhost:8000/mcp）。
• MCPサーバーのデプロイ方法に応じて、URLスキーマにhttpまたはhttpsを使用してください。
• commandやargsを指定する必要はありません。HTTPエンドポイントを指定するだけです。
• これは、HTTPを介してMCPをサポートする任意のツールまたはアシスタントに適用されます。
• サーバーはHTTP（SSE）モードで実行されている必要があります（この実装のデフォルト）。

ヘルスチェック

curl http://localhost:8000/health

サーバーはデフォルトでポート8000で実行されます。

📚 その他

1. 何か質問がある場合は、Slackコミュニティに参加し、#mcpチャンネルでメッセージを送信してください。
2. セットアップせずに試したい場合は、このドキュメントに従って、DrDroidクラウドプラットフォームでのクイックスタートを行ってください。