Peaka MCP Server

🚀 Peaka-MCP-Server 中文版

模型上下文協議（MCP）是一個新標準協議，用於管理大型語言模型（LLMs）與外部系統之間的上下文。Peaka 模型上下文協議服務器提供訪問 Peaka 的文本轉 SQL（text2SQL）功能的能力，讓 LLM 能夠查看模式並在提供的 Peaka 項目上執行 SQL 查詢。

🚀 快速開始

使用 Claude Desktop

1. 編輯配置文件 config.json：
   • 在 macOS 上：路徑為 ~/Library/Application Support/Claude/claude_desktop_config.json。
   • 在 Windows 上：路徑為 %APPDATA%\Claude\claude_desktop_config.json。
2. 添加配置到 mcpServers 對象：

{
  "mcpServers": {
    "peaka": {
      "command": "npx",
      "args": ["-y", "@peaka/mcp-server-peaka@latest"],
      "env": {
        "PEAKA_API_KEY": "<YOUR_API_KEY>"
      }
    }
  }
}

將 {PEAKA_API_KEY} 替換為你的項目 API 密鑰。你可以查看 Peaka 文檔以瞭解如何生成 API 密鑰，點擊此處獲取詳細說明。 3. 重啟 Claude Desktop

✨ 主要特性

Peaka 模型上下文協議服務器提供了訪問 Peaka 的文本轉 SQL 功能的能力，使 LLM 能查看模式並執行 SQL 查詢。

📚 詳細文檔

組件

資源

• peaka_sql_query_rule_set：Peaka SQL 查詢規則集是編寫 Peaka SQL 查詢的指南。

工具

• peaka_schema_retriever：用於檢索表元數據和模式，元數據包含列類型以及表與其他表之間的關係。
• peaka_query_golden_sqls：可從 Peaka 的金色 SQL 向量存儲中查詢問題/SQL 對。
• peaka_execute_sql_query：用於在 Peaka 上運行給定的 SQL 查詢。

環境變量

你可以使用以下環境變量進行配置：

📄 聯繫方式

有關功能請求和錯誤，請在該倉庫中創建問題。如需進一步支持，請參閱以下資源：

• Peaka 社區 Discord