Splunk MCP

🚀 Splunk MCP框架使用指南

本指南將詳細介紹如何使用Splunk MCP框架，該框架提供了靈活的配置選項和多種運行模式，可快速接入Splunk服務，還支持與Claude Desktop無縫集成。

🚀 快速開始

要使用Splunk MCP框架，您需要先完成安裝和配置，然後根據需求選擇合適的運行模式。

📦 安裝指南

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

✨ 主要特性

• 多種運行模式：支持SSE模式（推薦生產環境）和STDIO模式（適合開發測試）。
• 靈活配置：可通過配置文件輕鬆調整基本配置和日誌配置。
• 無縫集成：支持與Claude Desktop集成。

💻 使用示例

基礎用法

列出可用索引

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

搜索事件

$ 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/

集成測試

在集成環境中運行端到端測試，確保各模塊協同工作正常。

📄 許可證

文檔未提及許可證相關信息。

總結：該框架提供靈活的配置選項和多種運行模式，適用於不同的使用場景。通過簡單的配置即可快速接入Splunk服務，並支持與Claude Desktop無縫集成。如需更多幫助，請參考官方文檔或聯繫技術支持團隊。