Peaka MCP Server

peaka mcp服务器

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

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

此服务器使LLM能够检查模式并在提供的Peaka项目上执行sql查询。

组件

资源

• peaka_sql_query_rule_set

- Peaka SQL查询规则集是为Peaka编写SQL查询的指南。

• peaka_artifact_template

- 用于从Peaka查询结果生成可视化报告、仪表板和工件的样式指南和HTML模板。

工具

每个项目范围的工具都需要一个 projectId 争论。如果MCP客户端还不知道projectId，它应该调用 peaka_list_projects 首先，将所选id传递给后续调用。服务器本身在项目选择方面是无状态的——每个调用都携带自己的projectId。

• peaka_list_projects

- 列出使用当前API密钥可访问的所有项目。对于合作伙伴API密钥，列举所有组织和工作区中的项目。对于项目API键，返回绑定到该键的单个项目。

• peaka_query_golden_sqls

- 从Peaka的黄金sql向量存储中查询问题/sql对。如果现有查询与用户的问题匹配，则可以直接重用。

• peaka_execute_sql_query

- 在Peaka上运行给定的sql查询。

• peaka_get_project_metadata

- 在一次调用中获取Peaka项目中所有目录、模式和表的元数据。可选过滤条件 catalogId 和 schemaName.

• peaka_list_catalogs

- 列出Peaka项目中的所有可用目录。返回目录名称、类型和连接信息。

• peaka_list_schemas

- 列出Peaka项目中给定目录的所有可用模式。

• peaka_list_tables

- 列出Peaka项目中给定目录和模式的所有可用表。

• peaka_list_columns

- 列出Peaka项目中给定表的所有列。返回列名、数据类型和约束。

• peaka_get_relations

- 获取目录的表关系（外键）。有助于构建精确的JOIN。

• peaka_get_table_statistics

- 获取表的列级统计信息，包括每列的不同值分数。

• peaka_create_cache

- 为Peaka项目中的表创建缓存。缓存表通过在本地存储数据来提高查询性能。

• peaka_create_cache_batch

- 在一次调用中为多个表创建缓存。优先于重复 peaka_create_cache 电话。

• peaka_get_cache_statuses

- 获取Peaka项目中表的所有缓存状态，包括当前缓存状态、执行历史和进度。

• peaka_refresh_cache_full

- 触发对现有缓存的完全刷新。

• peaka_refresh_cache_incremental

- 触发对现有缓存的增量更新，仅获取新的或更改的行。

• peaka_update_cache

- 更新现有缓存上的缓存设置（计划）。每次通话完全替换两个时间表。

• peaka_delete_cache

- 删除现有缓存；基础表不受影响。

• peaka_list_queries

- 列出Peaka项目中所有已保存的查询。返回查询名称、SQL内容以及它们是纯文本还是物化。

• peaka_execute_query

- 在Peaka项目中按ID执行已保存的查询。

• peaka_create_query

- 在项目的语义层中创建一个命名的、已保存的查询。返回创建的查询及其ID。

• peaka_update_query

- 更新现有已保存查询的显示名称和/或SQL正文。

• peaka_delete_query

- 从Peaka项目中删除已保存的查询。

• peaka_list_connections

- 列出Peaka项目中的所有数据源连接，包括每个连接的id、名称和类型。

• peaka_get_connection_detail

- 获取数据源连接的特定连接配置详细信息。

• peaka_create_semantic_catalog

- 在Peaka项目中创建语义目录。语义目录将语义表（保存的查询显示为可查询表）分组到单个名称空间下。

• peaka_create_semantic_table

- 在语义目录中创建一个语义表，并由已保存的查询作为支持。需要 catalogId, schemaName, tableName，以及 queryId.

• peaka_delete_semantic_table

- 从语义目录中删除语义表。底层保存的查询不受影响。

• peaka_refresh_project_metadata

- 刷新特定目录的项目元数据。长跑；触发刷新并轮询完成。

• peaka_get_metadata_refresh_status

- 检查特定目录的元数据刷新作业的当前状态。

使用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": ""
      }
    }
  }
}

更改 {PEAKA_API_KEY} 使用您的项目API密钥。查看Peaka文档以创建API密钥，并按照详细说明单击 这里.

• 重新启动克劳德桌面

打包为Claude Desktop扩展

此回购随附 pack 构建服务器然后运行的脚本 mcpb pack （从 @anthropic-ai/mcpb)生产a .mcpb bundle-一个类似zip的存档，包含构建的服务器和 manifest.json Claude Desktop可以作为自定义MCP扩展加载。

npm run pack

这产生 peaka-mcp-server.mcpb 在repo根目录下。要安装它，请打开Claude Desktop→ 设置→ 扩展->高级设置->安装扩展->选择 .mcpb 文件->提示时输入API键并启用扩展。

环境变量

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

联系

对于功能请求和错误，请在此仓库中创建一个问题。如需更多支持，请参阅以下资源：

• Peaka社区不和