Splunk MCP

🚀 Splunk MCPフレームワーク使用ガイド

このフレームワークは、柔軟な設定オプションと複数の実行モードを提供し、様々な使用シーンに対応しています。簡単な設定でSplunkサービスに迅速に接続でき、Claude Desktopとのシームレスな統合もサポートしています。

🚀 クイックスタート

このガイドでは、Splunk MCPフレームワークのインストール、設定、実行モード、使用例、トラブルシューティング、Claude Desktopとの統合、テスト方法などについて説明します。

📦 インストール

1. 依存関係のインストール

以下のコマンドを実行して、必要な依存関係をインストールします。

pip install python-splunk-sdk python-decouple starlette asyncstdlib

2. 設定ファイルの作成と編集

設定ファイル config.ini を作成し、以下の情報を記入します。

[SPLUNK]
host = あなたのSplunkホストアドレス
port = ポート番号、デフォルトは8089
username = Splunkユーザー名
password = Splunkパスワード
scheme = プロトコル、httpまたはhttpsが選択可能、デフォルトはhttps
verify_ssl = SSL証明書を検証するかどうか、trueまたはfalse

[MCP]
mode = モード、saeまたはstdioが選択可能、デフォルトはsae
port = MCPサービスが監視するポート、デフォルトは8001

💻 使用例

基本的な使用法

1. 利用可能なインデックスの一覧表示

$ poetry run python splunk_mcp.py stdio
> |indices
{
    "result": [
        "default",
        "index_1",
        "search"
    ],
    "success": true,
    "message": ""
}

2. イベントの検索

$ poetry run python splunk_mcp.py stdio
> search index=_internal | stats count
{
    "result": [
        {
            "count": 12345
        }
    ],
    "success": true,
    "message": ""
}

📚 ドキュメント

実行モードの説明

1. SSEモード（本番環境での推奨）

poetry run python splunk_mcp.py sae

• 起動後、/sse エンドポイントを介して接続し、リアルタイムイベントストリームを受信できます。

2. STDIOモード（開発とテストに適しています）

poetry run python splunk_mcp.py stdio

• クエリコマンドを入力し、結果を出力します。

  $ poetry run python splunk_mcp.py stdio
  > |indices
  {
    "result": [
      "default",
      "index_1",
      "search"
    ],
    "success": true,
    "message": ""
  }
  

設定パラメータの説明

基本設定

• host: Splunk HECアドレス、デフォルトはlocalhost
• port: 監視ポート、デフォルトは8001
• mode: 実行モード、saeまたはstdioが選択可能

ログ設定

• log_level: ログレベル、デフォルトはinfo
• log_file: ログファイルのパス、設定しない場合はコンソールに出力されます

🔧 トラブルシューティング

接続問題

• ネットワーク接続を確認し、Splunkサービスが起動していることとポートが開いていることを確認します。
• ログファイルを確認し、詳細なエラー情報を取得します。

認証問題

• ユーザー名とパスワードが正しいことを確認します。
• ユーザーの権限が十分であることを確認します。

🔌 Claude Desktopとの統合

Claudeの設定ファイル claude_desktop_config.json を編集し、以下の内容を追加します。

{
    "splunk": {
        "host": "localhost",
        "port": 8089,
        "username": "admin",
        "password": "password",
        "mode": "stdio"
    }
}

🧪 テストガイド

単体テスト

以下のコマンドを実行して、単体テストを実行します。

pytest tests/

統合テスト

統合環境でエンドツーエンドテストを実行し、各モジュールが正常に連携していることを確認します。