Grist MCP Server

🚀 Grist MCP 服务器

Grist MCP 服务器是为 Grist 打造的 MCP 服务器，提供了 11 种工具，可用于处理文档、记录、SQL 和页面等操作，极大提升了数据处理与管理的效率。

🚀 快速开始

Claude Code（推荐）

使用以下命令可以快速启动 Grist MCP 服务器：

claude mcp add grist --env GRIST_API_KEY=your_api_key --env GRIST_BASE_URL=https://docs.getgrist.com -- npx -y grist-mcp-server

Claude 桌面端（MCPB 捆绑包）

按照以下步骤在 Claude 桌面端安装并配置 Grist MCP 服务器：

1. 从 发行版 下载 grist-mcp-server.mcpb 文件。
2. 在 Claude 桌面端中，依次点击：设置 → 开发者 → MCP 服务器 → 从 MCPB 安装。
3. 配置你的 Grist API 密钥和基础 URL。
4. 重启 Claude 桌面端。

手动配置（.mcp.json）

在你的 .mcp.json 文件中添加以下内容：

{
  "mcpServers": {
    "grist": {
      "command": "npx",
      "args": ["-y", "grist-mcp-server"],
      "env": {
        "GRIST_API_KEY": "your_api_key",
        "GRIST_BASE_URL": "https://docs.getgrist.com"
      }
    }
  }
}

从源代码安装

执行以下命令从源代码安装 Grist MCP 服务器：

git clone https://github.com/gwhthompson/grist-mcp-server.git
cd grist-mcp-server
npm install && npm run build

然后在你的 MCP 配置中添加以下内容：

{
  "mcpServers": {
    "grist": {
      "command": "node",
      "args": ["/path/to/grist-mcp-server/dist/index.js"],
      "env": {
        "GRIST_API_KEY": "your_api_key",
        "GRIST_BASE_URL": "https://docs.getgrist.com"
      }
    }
  }
}

✨ 主要特性

Grist MCP 服务器提供了丰富的工具，以下是各工具及其用途：

💻 使用示例

创建数据库

按照以下步骤创建数据库：

1. grist_get_workspaces → 查找工作区
2. grist_create_document → 创建文档
3. grist_manage_schema → 创建带有列的表

导入数据

按照以下步骤导入数据：

1. grist_get_documents → 查找文档
2. grist_get_tables → 检查结构
3. grist_manage_records → 插入更新数据（添加新数据，更新现有数据）

查询数据

按照以下步骤查询数据：

1. grist_get_tables → 了解模式
2. grist_query_sql → 运行包含 JOIN 和聚合操作的 SQL 查询

📚 详细文档

工具描述较为简洁，你可以使用 grist_help 命令获取详细信息：

• grist_help({tools: ["grist_manage_records"], only: ["examples"]})
• grist_help({tools: ["grist_query_sql"], only: ["errors"]})

版本历史请参考 CHANGELOG.md。

🔧 技术细节

故障排除

• 服务器无法启动：检查配置中是否设置了 GRIST_API_KEY。
• 身份验证失败：在 https://docs.getgrist.com/settings/keys 验证 API 密钥。
• 文档列表为空：检查 GRIST_BASE_URL 是否与你的 Grist 实例匹配。
• 连接错误（自托管）：验证 URL 是否包含 https:// 并且服务器是否可访问。

测试

使用以下命令进行测试（需要 Docker，容器生命周期自动管理）：

npm test

📄 许可证

本项目遵循 Apache-2.0 许可证。

🔗 相关链接

• Grist 文档
• Grist 社区
• MCP 协议
• 报告问题