peaka-mcp-server

模型上下文协议 (MCP) 是一个新的标准化协议，用于管理大型语言模型 (LLM) 和外部系统之间的上下文。

Peaka 模型上下文协议服务器，提供对 Peaka SQL text2SQL 功能的访问。

该服务器使 LLM 能够检查模式并在提供的 Peaka 项目上执行 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 查询。

与 Claude Desktop 一起使用

• 编辑配置文件 config.json：
  • 在 macOS 上：~/Library/Application Support/Claude/claude_desktop_config.json
  • 在 Windows 上：%APPDATA%\Claude\claude_desktop_config.json
• 将以下配置添加到 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 密钥，并通过单击此处 按照详细说明进行操作。

• 重启 Claude Desktop

环境变量

您可以使用以下环境变量进行配置：

名称	描述	默认值
DBC_BASE_URL	Peaka 数据操作的基本 URL，用于运行 SQL 查询	https://dbc.peaka.host:4567
PEAKA_API_KEY	用于向 Peaka 服务进行身份验证的项目 API 密钥。	-
PARTNER_API_BASE_URL	Peaka 合作伙伴 API 的基本 URL	https://partner.peaka.studio/api/v1

联系方式

对于功能请求和错误，请在此存储库中创建一个 issue。 如需进一步支持，请参阅以下资源：

• Peaka 社区 Discord