模型上下文协议(MCP)是一个新标准协议,用于管理大型语言模型(LLMs)与外部系统之间的上下文。Peaka 模型上下文协议服务器提供访问 Peaka 的文本转 SQL(text2SQL)功能的能力,使 LLM 能够查看模式并执行在提供的 Peaka 项目上的 SQL 查询。
config.json
:
~/Library/Application Support/Claude/claude_desktop_config.json
。%APPDATA%\Claude\claude_desktop_config.json
。mcpServers
对象中:{
"mcpServers": {
"peaka": {
"command": "npx",
"args": ["-y", "@peaka/mcp-server-peaka@latest"],
"env": {
"PEAKA_API_KEY": ""
}
}
}
}
请将 {PEAKA_API_KEY}
替换为你的项目 API 密钥。你可以查看 Peaka 文档以了解如何生成 API 密钥,点击此处获取详细说明。
3. 重启 Claude Desktop
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 查询。你可以使用以下环境变量进行配置:
属性 | 详情 |
---|---|
DBC_BASE_URL | Peaka 数据操作的基础 URL,用于运行 SQL 查询,默认值为 https://dbc.peaka.host:4567 |
PEAKA_API_KEY | 项目 API 密钥,用于身份验证与 Peaka 服务,无默认值 |
PARTNER_API_BASE_URL | Peaka 合作伙伴 API 的基础 URL,默认值为 https://partner.peaka.studio/api/v1 |
有关功能请求和错误,请在该仓库中创建问题。如需进一步支持,请参阅以下资源: