Kusto MCP

🚀 自然語言到Kusto查詢的MCP服務器

這是一個可配置的MCP服務器，能夠將自然語言轉換為Kusto查詢，並在Kusto中執行這些查詢，為用戶提供便捷的查詢轉換與執行服務。

🚀 快速開始

本服務器具備將自然語言轉化為Kusto查詢並執行的能力，以下是詳細的功能與使用說明。

✨ 主要特性

• 配置靈活：可以通過YAML文件進行配置。
• 查詢生成：根據提示生成Kusto查詢。
• 查詢執行：執行生成的Kusto查詢。
• 多庫支持：支持多個Kusto數據庫。

📦 安裝指南

從項目根目錄運行以下命令進行構建：

docker build ./src/Server/Dockerfile src

💻 使用示例

基礎用法

環境變量引用

在配置文件中，您可以引用以下環境變量：

{
  "endpoint": "your-kusto-endpoint",
  "appid": "${env:AZURE_CLIENT_ID}",
  "appkey": "${env:AZURE_CLIENT_SECRET}"
}

模型配置示例

{
  "model": {
    "type": "openai",
    "config": {
      "temperature": 0.7,
      "max_tokens": 1000,
      "api_key": "${env:AZURE_OPENAI_KEY}"
    }
  },
  "kusto": {
    "clusters": {
      "your-cluster-name": {
        "endpoint": "https://your-kusto-endpoint",
        "appid": "${env:AZURE_CLIENT_ID}",
        "appkey": "${env:AZURE_CLIENT_SECRET}"
      }
    }
  }
}

Kusto配置示例

clusters:
  your-cluster-name:
    endpoint: https://your-kusto-endpoint
    auth:
      appid: your-app-id
      appkey: your-app-key

高級用法

VS Code中的使用

在.vscode/mcp.json中添加以下內容：

{
  "inputs": [
    {
        "type": "promptString",
        "id": "azure-open-ai-key",
        "description": "請輸入您的Azure OpenAI密鑰",
        "password": true
    },
    {
        "type": "promptString",
        "id": "kusto-token",
        "description": "請輸入您的Kusto令牌",
        "password": true
    }
  ],
  "kusto": {
    "type": "stdio",
    "command": "docker",
    "args": [
        "run",
        "-i",
        "--rm",
        "-v",
        "/path/to/settings.yaml:/app/settings.yaml", // 輸入settings.yaml文件的路徑。可以使用VSCode變量
        // 包括在settings.yaml文件中引用的環境變量
        "-e",
        "AZURE_OPENAI_KEY",
        "-e",
        "KUSTO_ACCESS_TOKEN",
        "alexeyler/kusto-mcp-server",
    ],
    "env": {
        "AZURE_OPENAI_KEY": "${input:azure-open-ai-key}",
        "KUSTO_ACCESS_TOKEN": "${input:kusto-token}",
    }
  }
}

📚 詳細文檔

工具列表

1. 配置工具

• 用途：通過YAML文件進行配置。
• 輸入參數：
  • endpoint：指定Kusto集群的終結點。
  • appid 和 appkey：用於身份驗證的憑據。

2. 查詢生成工具

• 用途：根據提示生成Kusto查詢。
• 輸入參數：
  • prompt：用戶提供的提示信息。
  • context（可選）：上下文信息，以JSON格式提供。
  • options（可選）：選項信息，同樣以JSON格式提供。

3. 執行查詢工具

• 用途：執行Kusto查詢並返回結果。
• 輸入參數：
  • query：要執行的查詢語句。
  • context（可選）：上下文信息，以JSON格式提供。
  • options（可選）：選項信息，同樣以JSON格式提供。

4. 多數據庫支持工具

• 用途：支持在多個Kusto數據庫之間切換。
• 輸入參數：
  • database：指定要操作的數據庫名稱。

⚠️ 重要提示

• 確保所有endpointURL正確且可訪問。
• 更新prompts部分以包含相關查詢和說明，內容越詳細越好。
• 使用提供的示例配置作為模板來創建自己的settings.yaml文件。