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 協議
• 報告問題