Grist Mcp Server

Grist MCP Server

[CI] [codecov] [npm] [License] [MCP]

MCP server for Grist. 11 tools for documents, records, SQL, and pages.

Quick Start

Claude Code (recommended)

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 Desktop (MCPB bundle)

1. Download grist-mcp-server.mcpb from Releases
2. In Claude Desktop: Settings → Developer → MCP Servers → Install from MCPB
3. Configure your Grist API key and base URL
4. Restart Claude Desktop

Manual configuration (.mcp.json)

Add to your .mcp.json file:

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

Install from source

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

Add to your MCP config:

{  "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"      }    }  }}

Cloudflare Workers (HTTP transport)

Deploy as a remote MCP server using Cloudflare Workers for HTTP-based access.

Local development:

npm run worker:dev

Deploy to Cloudflare:

npm run worker:deploy

Configuration:

The Workers deployment uses header-based authentication:

• X-Grist-API-Key: Your Grist API key (required)
• X-Grist-Base-URL: Grist instance URL (optional, defaults to https://docs.getgrist.com)

Endpoint: https://your-worker.workers.dev/mcp

Example request:

curl -X POST https://your-worker.workers.dev/mcp \  -H "Content-Type: application/json" \  -H "X-Grist-API-Key: your_api_key" \  -d '{"jsonrpc":"2.0","method":"tools/list","id":1}'

Notes:

• Stateless design: Each request creates a fresh server instance
• CORS enabled for all origins (safe because auth uses headers, not cookies)
• Configure environment variables via wrangler secret put GRIST_API_KEY

Tools

Examples

Create a database

1. grist_get_workspaces → find workspace2. grist_create_document → create document3. grist_manage_schema → create tables with columns

Import data

1. grist_get_documents → find document2. grist_get_tables → check structure3. grist_manage_records → upsert data (adds new, updates existing)

Query data

1. grist_get_tables → understand schema2. grist_query_sql → run SQL with JOINs and aggregations

Troubleshooting

Server won't start: Check GRIST_API_KEY is set in config.

Authentication fails: Verify API key at https://docs.getgrist.com/settings/keys.

Empty document list: Check GRIST_BASE_URL matches your Grist instance.

Connection errors (self-hosted): Verify URL includes https:// and server is reachable.

Testing

npm test  # Docker required - container lifecycle is automatic

Documentation

Tool descriptions are concise. Use grist_help for details:

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

See CHANGELOG.md for version history.

Links

• Grist Documentation
• Grist Community
• MCP Protocol
• Report Issues