peaka-mcp-server
2025.04.07
0
TypeScript数据库查询模式管理text2SQL数据库开发效率
peaka-mcp-server 是一个基于 Model Context Protocol (MCP) 的服务，专门用于管理大型语言模型 (LLMs) 与外部系统之间的上下文。该服务器提供了 Peaka SQL 的 text2SQL 能力，使 LLMs 能够检查模式并在提供的 Peaka 项目上执行 SQL 查询。
View on GitHub
Overview
基本能力
产品定位
peaka-mcp-server 是一个用于数据库查询和模式管理的工具，特别适用于需要将自然语言转换为 SQL 查询的场景。
核心功能
- 模式检索：通过
peaka_schema_retriever工具检索表元数据和模式，包括列类型和表之间的关系。 - 查询黄金 SQL：通过
peaka_query_golden_sqls工具从 Peaka 的黄金 SQL 向量存储中查询问题/SQL 对。 - 执行 SQL 查询：通过
peaka_execute_sql_query工具在 Peaka 上运行给定的 SQL 查询。
适用场景
- 需要将自然语言转换为 SQL 查询的开发场景。
- 数据库模式管理和查询优化。
- 与大型语言模型集成，增强其数据库交互能力。
工具列表
peaka_schema_retriever：检索表元数据和模式。peaka_query_golden_sqls：查询问题/SQL 对。peaka_execute_sql_query：执行 SQL 查询。
常见问题解答
- 如何获取 API 密钥？请参考 Peaka 文档。
- 如何配置环境变量？请参考 README 中的环境变量部分。
使用教程
使用依赖
- 需要安装 Node.js 和 npm。
安装教程
- 编辑配置文件
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 密钥。 - 重启 Claude Desktop。
调试方式
- 确保环境变量
PEAKA_API_KEY已正确设置。 - 检查
DBC_BASE_URL和PARTNER_API_BASE_URL是否正确配置。