Grist for AI agents
Agents read Grist at once. Changes and sends are held for a person's approval by default.
About Grist
Grist is a relational spreadsheet platform that combines the flexibility of a spreadsheet with the robustness of a database, allowing users to create custom applications tailored to their data needs.
What an agent can do in Grist
Every Grist action is classed by the platform as a read, a change or a send. Reads run at once. Changes and sends are held for a person by default.
Runs at once (reads)
Looks things up in Grist without asking first. 11 actions.
- Fetch Document MetadataTool to fetch metadata for a specified Grist document. Use after obtaining the document ID.
- Fetch Table MetadataTool to retrieve metadata for a specified table in a Grist document. Use when you need to inspect table schema details before data operations.
- Get Org AccessRetrieves the list of users who have access to a Grist organization along with their access roles (owners, editors, viewers). Use this to find user IDs, emails, or check access permissions within an o
- Get UsersTool to retrieve a list of users via SCIM v2. Use when you need to page through and filter enterprise users in Grist.
- List RecordsTool to retrieve records from a specified table within a Grist document. Use when you need to fetch rows by applying optional filters, sorting, limits, or hidden columns. Example: list records where p
- List TablesTool to list all tables within a specified document. Use after obtaining the document ID to retrieve its tables.
- List AttachmentsTool to list all attachments in a Grist document. Use after confirming the document ID to retrieve attachment metadata.
- List ColumnsTool to list all columns in a specified Grist table. Use after selecting the document and table to inspect column metadata.
- List OrganizationsTool to list all organizations accessible to the authenticated user. Use when you need to select a Grist organization for subsequent operations.
- List WebhooksList all webhooks configured for a Grist document. Returns webhook configuration details (URL, event types, table binding) and delivery status information. Use this to inspect, audit, or manage webhoo
- List WorkspacesTool to list all workspaces and documents accessible to the authenticated user on the current site. Use when you need to select a workspace or document for subsequent operations.
Held for approval by default (changes and sends)
Held for a person's approval by default. The approval is recorded and the action is sent once, never twice, with 10 seconds to undo. 17 actions.
- Add RecordsAdd one or more records to a Grist table. First use GRIST_LIST_WORKSPACES to get docId, GRIST_LIST_TABLES to get tableId, and GRIST_LIST_COLUMNS to get column IDs for the fields mapping.
- Delete Grist Table RecordsTool to delete records from a specified Grist table. Use when you need to remove specific rows by their IDs. Use after confirming the row IDs exist.
- Run SQL QueryTool to execute a read-only SQL SELECT query on a Grist document. Use after confirming the document ID and preparing a valid SQL SELECT statement.
- Update RecordsUpdate existing records in a Grist table by their row IDs. Use this tool to modify field values for one or more records in a specified document and table. First use GRIST_LIST_RECORDS to obtain the re
- Create DocumentCreates a new Grist document in a specified workspace. Use this tool when you need to add a new spreadsheet document to a workspace. Requires a valid workspace ID (obtainable via GRIST_LIST_WORKSPACES
- Create SCIM UserTool to create a new SCIM user. Use when provisioning new user accounts via SCIM. Run after gathering all required user details.
- Create TableTool to create tables in a document. Use after confirming the document ID. Creates one or more tables with specified columns in the given document.
- Create Document WebhookTool to create a new webhook for a specified document. Use when you need to register webhook endpoints for document events in Grist. Run after confirming document ID.
- Remove Unused AttachmentsRemove unused attachments from a Grist document to free up storage space. IMPORTANT: This action removes ALL attachments that are not currently referenced by any cell in the document. It does NOT dele
- Delete ColumnTool to delete a column from a Grist document table. Use after confirming document, table, and column IDs.
- Delete SCIM UserDelete a user from the Grist organization by their numeric user ID. Use GRIST_GET_USERS first to find the user's ID. Falls back to org access API if SCIM is not enabled. Note: Cannot delete your own a
- Delete WebhookPermanently removes a webhook from a Grist document. Use this tool when you need to stop receiving notifications for document changes. First use GRIST_LIST_WEBHOOKS to find the webhook_id you want to
Show all 17
- Update Column MetadataUpdates metadata (label, type, description, formula, etc.) for one or more columns in a Grist table. Use List Columns first to get valid column IDs. Warning: changing 'label' may rename the column ID
- Update Document MetadataTool to update metadata for a specified Grist document. Use when you need to rename or pin/unpin a document after obtaining its ID.
- Update Table MetadataUpdate metadata properties for a table in a Grist document. Currently the main updatable property is 'onDemand' which controls lazy loading of table data. Use List Tables to find valid table IDs first
- Update WebhookUpdate an existing webhook configuration for a Grist document. Use to modify webhook settings such as URL, event types, enabled status, or target table. Requires valid document ID (from GRIST_LIST_WOR
- Upload AttachmentUpload one or more file attachments to a Grist document. Returns attachment IDs that can be used to link files to records in Attachments-type columns. First use GRIST_LIST_WORKSPACES to get a valid do
Changes wait in Needs you
Changes and sends in Grist are held for a person's approval by default. The approval is recorded, and the action is sent once, never twice, with 10 seconds to undo.
Grist questions
Can an agent change data in Grist on its own?
Not by default. Changes and sends in Grist are held for a person's approval. The approval is recorded, and the action is sent once, never twice, with 10 seconds to undo.
What can an agent read in Grist?
This connector lists 11 read actions. Reads run at once, without waiting for approval.
How does Grist connect?
It connects with API key. Connectors are built and maintained by third-party developers; availability is confirmed during scoping.