productivity
Grist MCP, CLI, and Lua Integration for AI Agents
Grist integration docs for AI agents: MCP gateway setup, Grist CLI commands, Lua API reference, credentials, and function schemas.
13 functions 9 read 4 write API key auth
Grist for agents
Credentials can be configured manually in web or CLI hosts.
Use this integration from Lua code mode, the headless integrations CLI, or the KosmoKrator MCP gateway. The same package metadata powers all three surfaces.
Machine-Readable Metadata
- integration_slug
grist- route_slug
grist- package
grist- auth_strategy
api_keyAPI key- cli_setup_supported
true- cli_runtime_supported
true- mcp_gateway_supported
true- lua_supported
true- supports_multi_account
true
Quick Links
Lua APIAgent-facing namespace and function reference. Grist CLIHeadless setup and direct function calls. Grist MCPMCP gateway setup for external clients. Submit feedbackReport missing tools, auth problems, wrong docs, or runtime issues. ContributeAdd tools or improve metadata in the integrations repo.
Grist MCP Client Matrix
Use these pages when a specific agent client or framework needs copy-pasteable MCP setup for Grist.
Claude Code Grist MCP setup for Claude Code. Cursor Grist MCP setup for Cursor. Codex Grist MCP setup for Codex. OpenAI Agents Grist MCP setup for OpenAI Agents SDK. Claude Agent SDK Grist MCP setup for Claude Agent SDK. Vercel AI SDK Grist MCP setup for Vercel AI SDK. LangChain Grist MCP setup for LangChain. LangGraph Grist MCP setup for LangGraph. CrewAI Grist MCP setup for CrewAI. MCP clients Grist MCP setup for Generic MCP Clients.
Grist CLI Matrix
Use these pages for direct Grist CLI workflows in scripts, CI, cron, and agent wrappers.
CI Grist CLI for CI. Cron Jobs Grist CLI for cron jobs. Shell Scripts Grist CLI for shell scripts. Headless Automation Grist CLI for headless automation. Coding Agents Grist CLI for coding agents.
Function Catalog
| Function | Type | Parameters | Description |
|---|---|---|---|
grist.grist_list_workspaces | Read read | 1 | List all workspaces in a Grist organization. |
grist.grist_get_workspace | Read read | 1 | Get details for a single Grist workspace, including its documents. |
grist.grist_list_docs | Read read | 1 | List all documents in a Grist organization. |
grist.grist_get_doc | Read read | 1 | Get details for a single Grist document by ID. |
grist.grist_list_tables | Read read | 1 | List all tables in a Grist document. |
grist.grist_get_table | Read read | 2 | Get a single table from a Grist document. |
grist.grist_list_records | Read read | 5 | List records from a Grist table with optional filtering, sorting, and limiting. |
grist.grist_get_record | Read read | 2 | Get full column data for a Grist table (raw cell values per column). |
grist.grist_create_records | Write write | 3 | Create one or more records in a Grist table. |
grist.grist_update_records | Write write | 3 | Update one or more existing records in a Grist table. |
grist.grist_delete_records | Write write | 3 | Delete records from a Grist table by row IDs. |
grist.grist_create_column | Write write | 6 | Create a new column in a Grist table. |
grist.grist_list_columns | Read read | 2 | List all columns in a Grist table. |