mcp-server-grist

🚀 Grist MCP 服务器

Grist MCP 服务器是一个实现 Grist API 交互的工具，它搭建起了 Grist 电子表格与语言模型之间的桥梁，让二者的集成变得轻松简单。

✨ 主要特性

• 语言模型可直接访问 Grist 数据。
• 能够列出组织、工作区、文档、表和字段。
• 支持对 Grist 表中的记录进行查询、添加、更新和删除操作。
• 具备丰富的查询功能，可进行过滤和排序。
• 采用基于 API 密钥的安全认证机制。

📚 详细文档

工具介绍

list_organizations

• 功能：列出用户可访问的所有 Grist 组织。
• 返回：包含 ID、名称和域名的组织列表。

list_workspaces

• 功能：列出 Grist 组织中的所有工作区。
• 输入：
  • org_id (int 或 string)：要列出工作区的组织 ID。
• 返回：包含 ID 和名称的工作区列表。

list_documents

• 功能：列出 Grist 工作区中的所有文档。
• 输入：
  • workspace_id (int)：要列出文档的工作区 ID。
• 返回：包含 ID 和名称的文档列表。

list_tables

• 功能：列出 Grist 文档中的所有表。
• 输入：
  • doc_id (string)：文档的 ID，其中包含要列出的表。
  • table_id (string)：要列出字段的表 ID。
• 返回：包含 ID 和字段数据的列列表。

list_records

• 功能：根据可选过滤、排序和限制条件列出 Grist 表中的记录。
• 输入：
  • doc_id (string)：文档的 ID，其中包含表。
  • table_id (string)：要列出记录的表 ID。
  • filter_json (string, 可选)：过滤记录的 JSON 字符串（例如：{"column_name": ["value1", "value2"]}）。
  • sort (string, 可选)：按逗号分隔的排序列列表（前缀为'-'表示降序）。
  • limit (int, 可选)：最大返回记录数。
• 返回：包含 ID 和字段数据的记录列表。

add_grist_records

• 功能：向 Grist 表中添加记录。
• 输入：
  • doc_id (string)：文档的 ID，其中包含表。
  • table_id (string)：要添加记录的表 ID。
  • records (array)：要添加的记录列表（每个记录为字段值字典）。
• 返回：新创建记录的 ID 列表。

update_grist_records

• 功能：更新 Grist 表中的记录。
• 输入：
  • doc_id (string)：文档的 ID，其中包含表。
  • table_id (string)：要更新记录的表 ID。
  • records (array)：要更新的记录列表（每个记录为字段值字典）。
• 返回：成功更新的记录数量。

delete_grist_records

• 功能：从 Grist 表中删除记录。
• 输入：
  • doc_id (string)：文档的 ID，其中包含表。
  • table_id (string)：要删除记录的表 ID。
  • records (array)：要删除的记录列表（每个记录为字段值字典）。
• 返回：成功删除的记录数量。

📦 安装指南

Docker 安装

docker build -t mcp/grist-mcp-server .

常规安装

可以选择使用 pip 安装，或者手动克隆仓库安装：

pip install mcp-server-grist

手动安装步骤如下：

git clone https://github.com/yourusername/mcp-server-grist.git
cd mcp-server-grist
pip install -r requirements.txt

📄 许可证

此 MCP 服务器根据 MIT License 授权。