Grist MCP server
71 operations0 webhooks
Relational spreadsheet-database platform combining the flexibility of a spreadsheet with the robustness of a relational database.
Try Grist with your agent
Connect Grist, then paste this into Claude, ChatGPT or Cursor. For ideas from other apps, see the use cases.
Using Corsair, show me what you can do in Grist on my account, then run one read-only example and show me the result.
Grist tools and triggers
Tools are what your agent can do in Grist through Corsair's MCP server. Triggers are the Grist events a routine can start from.
Docs
- CopyWrite
Copy a document to a workspace
docs.copy
- CreateWrite
Create a new Grist document or copy from a template
docs.create
- Create In WorkspaceWrite
Create an empty document inside a specific workspace
docs.createInWorkspace
- DeleteDestructive
Permanently delete a document
docs.delete
- ForkWrite
Fork a document into a new unsaved document
docs.fork
- GetRead-only
Describe document metadata and containing workspace
docs.get
- List AccessRead-only
List users with access permissions to a document
docs.listAccess
- List SnapshotsRead-only
List historical snapshots of a document
docs.listSnapshots
- Modify AccessDestructive
Change user access permissions for a document; sharing with a new email address sends that person an invitation
docs.modifyAccess
- MoveWrite
Move a document to a different workspace
docs.move
- PinWrite
Pin a document for quick access
docs.pin
- RemoveDestructive
Move a document to the trash
docs.remove
- Remove SnapshotsDestructive
Remove historical snapshots of a document
docs.removeSnapshots
- UnpinWrite
Unpin a document
docs.unpin
- UnremoveWrite
Restore a document from the trash
docs.unremove
- UpdateWrite
Modify document metadata such as name or pin status
docs.update
Workspaces
- CreateWrite
Create a new empty workspace in an organization
workspaces.create
- DeleteDestructive
Permanently delete a workspace
workspaces.delete
- GetRead-only
Describe a workspace and its documents
workspaces.get
- ListRead-only
List workspaces and their documents within an organization
workspaces.list
- List AccessRead-only
List users with access permissions to a workspace
workspaces.listAccess
- Modify AccessDestructive
Change user access permissions for a workspace; sharing with a new email address sends that person an invitation
workspaces.modifyAccess
- RemoveDestructive
Move a workspace to the trash
workspaces.remove
- UnremoveWrite
Restore a workspace from the trash
workspaces.unremove
- UpdateWrite
Modify workspace name or settings
workspaces.update
Orgs
- DeleteDestructive
Delete an organization by ID and confirmed name
orgs.delete
- GetRead-only
Describe details of a specific organization
orgs.get
- Get UsageRead-only
Get organization resource and storage usage summary
orgs.getUsage
- ListRead-only
List organizations accessible to the authenticated user
orgs.list
- List AccessRead-only
List users with access permissions to an organization
orgs.listAccess
- Modify AccessDestructive
Change user access roles for an organization; sharing with a new email address sends that person an invitation
orgs.modifyAccess
- UpdateWrite
Modify organization metadata such as its name
orgs.update
Service Accounts
- CreateWrite
Create a new service account with an API key
serviceAccounts.create
- DeleteDestructive
Delete a service account
serviceAccounts.delete
- Delete Api KeyDestructive
Delete a service account API key
serviceAccounts.deleteApiKey
- GetRead-only
Get service account details by ID
serviceAccounts.get
- ListRead-only
List all service accounts owned by the user
serviceAccounts.list
- Regenerate Api KeyDestructive
Generate a new API key for a service account; the previous key stops working
serviceAccounts.regenerateApiKey
- UpdateWrite
Modify service account name or label
serviceAccounts.update
Attachments
- GetRead-only
Get metadata for a specific attachment in a document
attachments.get
- Get Transfer StatusRead-only
Get current attachment transfer status for an external store
attachments.getTransferStatus
- ListRead-only
List metadata for attachments stored in a document
attachments.list
- Remove UnusedDestructive
Delete unused attachments from a document
attachments.removeUnused
- Update UsedWrite
Update attachment usage tracking in a document
attachments.updateUsed
- Verify FilesRead-only
Verify attachment file integrity for a document
attachments.verifyFiles
Columns
- AddWrite
Add new columns to a table in a document
columns.add
- DeleteDestructive
Delete a column from a table
columns.delete
- ListRead-only
List columns and metadata for a table
columns.list
- ReplaceWrite
Add or update column definitions in a table
columns.replace
- UpdateWrite
Modify column configurations or labels in a table
columns.update
Records
- AddWrite
Add new records with field values to a table
records.add
- DeleteDestructive
Delete records by record IDs from a table
records.delete
- ListRead-only
Fetch records from a table with filtering and sorting
records.list
- ReplaceWrite
Add or update records matching require criteria (upsert)
records.replace
- UpdateWrite
Modify existing records by record ID in a table
records.update
Profile
- GetRead-only
Get current authenticated user profile
profile.get
- Update LocaleWrite
Update user locale preference
profile.updateLocale
- Update NameWrite
Update user display name
profile.updateName
Tables
- CreateWrite
Add new tables and their column definitions to a document
tables.create
- ListRead-only
List tables within a Grist document
tables.list
- UpdateWrite
Modify table identifiers or on-demand loading settings
tables.update
Users
- DeleteDestructive
Delete a user from Grist
users.delete
- DisableWrite
Disable a user account in Grist
users.disable
- EnableWrite
Enable a previously disabled user account
users.enable
Session
- Get ActiveRead-only
Get active session details and current organization
session.getActive
- Get AllRead-only
Get all logged-in session accounts and organizations
session.getAll
Sql
- QueryRead-only
Execute a read-only SQL query with parameters against a document
sql.query
- Query GetRead-only
Execute a simple read-only SQL query via GET against a document
sql.queryGet
Templates
- GetRead-only
Get details of a specific document template
templates.get
- ListRead-only
List available document templates from the catalog
templates.list
Widgets
- ListRead-only
List available custom widgets from the gallery
widgets.list
Connect Grist to Claude, ChatGPT or Cursor
- 1
Connect Grist in Corsair
Add your Grist API key once in Corsair. Corsair stores the credential encrypted and makes the Grist API calls for your agent, so it never goes into a prompt or a config file. Connect Grist
If your link lets the agent add apps, you can skip this: it gives you a sign-in link the first time it needs Grist. On a ChatGPT personal plan, connect Grist here first.
- 2
Add Corsair's MCP server to your agent
Every client uses the same address:
https://mcp.corsair.dev/mcpOpen Customize → Connectors → Add custom connector, paste the address, then select Connect.Add a custom MCP server with the address and choose OAuth. Personal plans get read tools only.Add to CursorOr add this to~/.cursor/mcp.json. Cursor opens Corsair to sign in the first time it connects.{ "mcpServers": { "corsair": { "url": "https://mcp.corsair.dev/mcp" } } }Run this, then run/mcpin Claude Code to sign in.claude mcp add --transport http corsair https://mcp.corsair.dev/mcpCodex, Gemini CLI, VS Code, Zed and other clients with OAuth sign-in work the same way. Clients without it, such as GitHub Copilot's coding agent, use a link's own address and an API key. Setup for every client
- 3
Sign in and choose what needs your approval
Your client opens Corsair to sign in. Pick a link: the apps your agent can use and a mode that decides what it may do without asking. In the default Cautious mode, Grist's read and write operations run right away and its 16 destructive operations wait for your approval. Strict mode asks before every write and refuses destructive operations, and Read mode allows reads only.
FAQ
Install corsair and @corsair-dev/grist, add the Grist plugin, and connect with an API key. Then call methods like corsair.grist.api.attachments.get() from your app. Corsair keeps each tenant isolated.
Yes. Grist requires an API key from your Grist account or developer dashboard. Create credentials with access that matches what you automate, then paste them into Corsair or connect through managed auth in Hub.
Yes. One Corsair client can hit Grist, GitHub, Notion, Stripe, and the rest. Trigger Grist from a webhook, push updates to Slack, or chain actions across plugins. Same tenant context across integrations, plain TypeScript.
Teams use Corsair for relational spreadsheet-database platform combining the flexibility of a spreadsheet with the robustness of a relational database. Common builds include sync jobs, admin tooling, and agents that call Grist APIs from your backend.
The SDK is open source. Self-host and you pay Corsair nothing for the integration layer. Hub bills for hosted auth and execution, not per Grist API call. Hub has a generous free tier. For hobby projects you can probably run the whole thing on free. Paid plans start to matter with more tenants or heavier traffic.
We maintain @corsair-dev/grist in the open repo. When Grist ships API changes, upgrade the package. Your call sites stay typed. You should not need to rewrite the integration layer each time.
No. Corsair does not read your Grist data or hold individual access credentials. Credentials stay in your database. API calls run on your instance. We do not store Grist data on your behalf.
Yes. Add https://mcp.corsair.dev/mcp as a custom connector or MCP server in Claude, ChatGPT, Cursor, VS Code, Claude Code, Codex or any client that supports remote MCP servers with OAuth sign-in, then sign in to Corsair. On ChatGPT personal plans, custom servers currently get read tools only.
Yes. Put Grist on a link in Strict mode and every write waits for your approval, while destructive actions are refused. The default Cautious mode asks only before the 16 destructive Grist operations. You can change a link's mode at hub.corsair.dev/me.