# Grist

```json
{
  "name": "Grist",
  "slug": "grist",
  "url": "https://composio.dev/toolkits/grist",
  "markdown_url": "https://composio.dev/toolkits/grist.md",
  "logo_url": "https://www.getgrist.com/static/images/logo.svg",
  "categories": [
    "productivity & project management"
  ],
  "is_composio_managed": false,
  "updated_at": "2026-05-12T10:14:24.273Z"
}
```

![Grist logo](https://www.getgrist.com/static/images/logo.svg)

## Description

Securely connect your AI agents and chatbots (Claude, ChatGPT, Cursor, etc) with Grist MCP or direct API to query tables, update records, automate workflows, and generate reports through natural language.

## Summary

Grist is a relational spreadsheet platform combining spreadsheet flexibility with database power. It helps you build custom applications tailored to your unique data needs.

## Categories

- productivity & project management

## Toolkit Details

- Tools: 30

## Images

- Logo: https://www.getgrist.com/static/images/logo.svg

## Authentication

- **Api Key**
  - Type: `api_key`
  - Description: Api Key authentication for Grist.
  - Setup:
    - Configure Api Key credentials for Grist.
    - Use the credentials when creating an auth config in Composio.

## Suggested Prompts

- Add new sales data to Q2 table
- Create a document for project planning
- Delete outdated rows from inventory sheet
- Remove email column from contacts table

## Supported Tools

| Tool slug | Name | Description |
|---|---|---|
| `GRIST_ADD_RECORDS` | Add Records | Add 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. |
| `GRIST_CREATE_DOCUMENT` | Create Document | Creates 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) and a document name. |
| `GRIST_CREATE_SCIM_USER` | Create SCIM User | Tool to create a new SCIM user. Use when provisioning new user accounts via SCIM. Run after gathering all required user details. |
| `GRIST_CREATE_TABLE` | Create Table | Tool to create tables in a document. Use after confirming the document ID. Creates one or more tables with specified columns in the given document. |
| `GRIST_CREATE_WEBHOOK` | Create Document Webhook | Tool 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. |
| `GRIST_DELETE_ATTACHMENT` | Remove Unused Attachments | Remove 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 delete a specific attachment by ID. To remove a specific attachment: 1. First remove its reference from the Attachments column cell that contains it 2. Then call this action to clean up the now-unreferenced file Attachments become "unused" when they are no longer referenced by any Attachments-type cell. Grist normally retains unreferenced attachments for a period to allow undo operations. This action removes them immediately (or only expired ones if expired_only=true). |
| `GRIST_DELETE_COLUMN` | Delete Column | Tool to delete a column from a Grist document table. Use after confirming document, table, and column IDs. |
| `GRIST_DELETE_RECORDS` | Delete Grist Table Records | Tool 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. |
| `GRIST_DELETE_SCIM_USER` | Delete SCIM User | Delete 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 account. |
| `GRIST_DELETE_WEBHOOK` | Delete Webhook | Permanently 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 delete. This action is destructive and cannot be undone. |
| `GRIST_DOWNLOAD_ALL_ATTACHMENTS_ARCHIVE` | Download All Attachments Archive | Download all attachments from a Grist document as a single archive file (.zip or .tar). Use this to bulk-download attachments. Ensure the document has attachments before calling (check with GRIST_LIST_ATTACHMENTS). Returns an empty archive if no attachments exist. |
| `GRIST_DOWNLOAD_ATTACHMENT` | Download Attachment | Download a file attachment from a Grist document. Returns the file content as a downloadable file. Use GRIST_LIST_ATTACHMENTS first to get valid attachment IDs. |
| `GRIST_FETCH_DOCUMENT_METADATA` | Fetch Document Metadata | Tool to fetch metadata for a specified Grist document. Use after obtaining the document ID. |
| `GRIST_FETCH_TABLE_METADATA` | Fetch Table Metadata | Tool to retrieve metadata for a specified table in a Grist document. Use when you need to inspect table schema details before data operations. |
| `GRIST_GET_ORG_ACCESS` | Get Org Access | Retrieves 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 organization. Useful for user management tasks. |
| `GRIST_GET_USERS` | Get Users | Tool to retrieve a list of users via SCIM v2. Use when you need to page through and filter enterprise users in Grist. |
| `GRIST_LIST_ATTACHMENTS` | List Attachments | Tool to list all attachments in a Grist document. Use after confirming the document ID to retrieve attachment metadata. |
| `GRIST_LIST_COLUMNS` | List Columns | Tool to list all columns in a specified Grist table. Use after selecting the document and table to inspect column metadata. |
| `GRIST_LIST_ORGANIZATIONS` | List Organizations | Tool to list all organizations accessible to the authenticated user. Use when you need to select a Grist organization for subsequent operations. |
| `GRIST_LIST_RECORDS` | List Records | Tool 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 pet is 'cat' sorted by '-age'. |
| `GRIST_LIST_TABLES` | List Tables | Tool to list all tables within a specified document. Use after obtaining the document ID to retrieve its tables. |
| `GRIST_LIST_WEBHOOKS` | List Webhooks | List 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 webhooks for a document. Requires a valid document ID obtained from GRIST_LIST_WORKSPACES or GRIST_CREATE_DOCUMENT. |
| `GRIST_LIST_WORKSPACES` | List Workspaces | Tool 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. |
| `GRIST_RUN_SQL_QUERY` | Run SQL Query | Tool 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. |
| `GRIST_UPDATE_COLUMN_METADATA` | Update Column Metadata | Updates 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 unless 'untieColIdFromLabel' is set to true. |
| `GRIST_UPDATE_DOCUMENT_METADATA` | Update Document Metadata | Tool to update metadata for a specified Grist document. Use when you need to rename or pin/unpin a document after obtaining its ID. |
| `GRIST_UPDATE_RECORDS` | Update Records | Update 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 record IDs you want to update. Supports batch updates - you can update multiple records in a single call. The API uses PATCH semantics, meaning only specified fields are updated; unspecified fields remain unchanged. IMPORTANT: When updating multiple records in a batch, all records must specify the exact same set of field names (e.g., if updating Name and Age for record 1, you must also update Name and Age for record 2). |
| `GRIST_UPDATE_TABLE_METADATA` | Update Table Metadata | Update 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. |
| `GRIST_UPDATE_WEBHOOK` | Update Webhook | Update 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_WORKSPACES) and webhook ID (from GRIST_LIST_WEBHOOKS). Only provided fields will be updated; omitted fields remain unchanged. |
| `GRIST_UPLOAD_ATTACHMENT` | Upload Attachment | Upload 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 document ID. |

## Supported Triggers

None listed.

## Installation and MCP Setup

### Path 1: SDK Installation

#### Path 1, Step 1: Install Composio

Install the Composio SDK
```python
pip install composio_openai
```

```typescript
npm install @composio/openai
```

#### Path 1, Step 2: Initialize Composio and Create Tool Router Session

Import and initialize Composio client, then create a Tool Router session
```python
from openai import OpenAI
from composio import Composio
from composio_openai import OpenAIResponsesProvider

composio = Composio(provider=OpenAIResponsesProvider())
openai = OpenAI()
session = composio.create(user_id='your-user-id')
```

```typescript
import OpenAI from 'openai';
import { Composio } from '@composio/core';
import { OpenAIResponsesProvider } from '@composio/openai';

const composio = new Composio({
  provider: new OpenAIResponsesProvider(),
});
const openai = new OpenAI({});
const session = await composio.create('your-user-id');
```

#### Path 1, Step 3: Execute Grist Tools via Tool Router with Your Agent

Get tools from Tool Router session and execute Grist actions with your Agent
```python
tools = session.tools
response = openai.responses.create(
  model='gpt-4.1',
  tools=tools,
  input=[{
    'role': 'user',
    'content': 'Add new rows to the “Sales” table for today’s transactions'
  }]
)
result = composio.provider.handle_tool_calls(
  response=response,
  user_id='your-user-id'
)
print(result)
```

```typescript
const tools = session.tools;
const response = await openai.responses.create({
  model: 'gpt-4.1',
  tools: tools,
  input: [{
    role: 'user',
    content: 'Add new rows to the “Sales” table for today’s transactions'
  }],
});
const result = await composio.provider.handleToolCalls(
  'your-user-id',
  response.output
);
console.log(result);
```

### Path 2: MCP Server Setup

#### Path 2, Step 1: Install Composio

Install the Composio SDK and Claude Agent SDK
```python
pip install composio claude-agent-sdk
```

```typescript
npm install @composio/core ai @ai-sdk/openai @ai-sdk/mcp
```

#### Path 2, Step 2: Create Tool Router Session

Initialize the Composio client and create a Tool Router session
```python
from composio import Composio
from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions

composio = Composio(api_key='your-composio-api-key')
session = composio.create(user_id='your-user-id')
url = session.mcp.url
```

```typescript
import { Composio } from '@composio/core';

const composio = new Composio({ apiKey: 'your-api-key' });

console.log("Creating Tool Router session...");
const { mcp } = await composio.create('your-user-id');
console.log(`Tool Router session created: ${mcp.url}`);
```

#### Path 2, Step 3: Connect to AI Agent

Use the MCP server with your AI agent
```python
import asyncio

options = ClaudeAgentOptions(
    permission_mode='bypassPermissions',
    mcp_servers={
        'tool_router': {
            'type': 'http',
            'url': url,
            'headers': {
                'x-api-key': 'your-composio-api-key'
            }
        }
    },
    system_prompt='You are a helpful assistant with access to Grist tools.',
    max_turns=10
)

async def main():
    async with ClaudeSDKClient(options=options) as client:
        await client.query('Add a new row to the "Sales" table in my Grist document with today\'s date and amount $5000')
        async for message in client.receive_response():
            if hasattr(message, 'content'):
                for block in message.content:
                    if hasattr(block, 'text'):
                        print(block.text)

asyncio.run(main())
```

```typescript
import { openai } from '@ai-sdk/openai';
import { experimental_createMCPClient as createMCPClient } from '@ai-sdk/mcp';
import { generateText, stepCountIs } from 'ai';

const client = await createMCPClient({
  transport: {
    type: 'http',
    url: mcp.url,
    headers: { 'x-api-key': 'your-composio-api-key' }
  }
});

const tools = await client.tools();

const { text } = await generateText({
  model: openai('gpt-4o'),
  tools,
  messages: [{ role: 'user', content: 'Add a new row to the "Sales" table in my Grist document with today\'s date and amount $5000' }],
  stopWhen: stepCountIs(5)
});

console.log(`Agent: ${text}`);
```

## Why Use Composio?

### 1. AI Native Grist Integration

- Supports both Grist MCP and direct API based integrations
- Structured, LLM-friendly schemas for reliable tool execution
- Rich coverage for reading, writing, and querying your Grist data

### 2. Managed Auth

- Built-in API key handling with secure storage and rotation
- Central place to manage, scope, and revoke Grist access
- Per user and per environment credentials instead of hard-coded keys

### 3. Agent Optimized Design

- Tools are tuned using real error and success rates to improve reliability over time
- Comprehensive execution logs so you always know what ran, when, and on whose behalf

### 4. Enterprise Grade Security

- Fine-grained RBAC so you control which agents and users can access Grist
- Scoped, least privilege access to Grist resources
- Full audit trail of agent actions to support review and compliance

## Use Grist with any AI Agent Framework

Choose a framework you want to connect Grist with:

- [OpenAI Agents SDK](https://composio.dev/toolkits/grist/framework/open-ai-agents-sdk)
- [Claude Agent SDK](https://composio.dev/toolkits/grist/framework/claude-agents-sdk)
- [Claude Code](https://composio.dev/toolkits/grist/framework/claude-code)
- [Claude Cowork](https://composio.dev/toolkits/grist/framework/claude-cowork)
- [Codex](https://composio.dev/toolkits/grist/framework/codex)
- [OpenClaw](https://composio.dev/toolkits/grist/framework/openclaw)
- [Hermes](https://composio.dev/toolkits/grist/framework/hermes-agent)
- [Google ADK](https://composio.dev/toolkits/grist/framework/google-adk)
- [LangChain](https://composio.dev/toolkits/grist/framework/langchain)
- [Vercel AI SDK](https://composio.dev/toolkits/grist/framework/ai-sdk)
- [Mastra AI](https://composio.dev/toolkits/grist/framework/mastra-ai)
- [LlamaIndex](https://composio.dev/toolkits/grist/framework/llama-index)
- [CrewAI](https://composio.dev/toolkits/grist/framework/crew-ai)
- [Pydantic AI](https://composio.dev/toolkits/grist/framework/pydantic-ai)
- [AutoGen](https://composio.dev/toolkits/grist/framework/autogen)

## Related Toolkits

- [Google Sheets](https://composio.dev/toolkits/googlesheets) - Google Sheets is a cloud-based spreadsheet tool for real-time collaboration and data analysis. It lets teams work together from anywhere, updating information instantly.
- [Notion](https://composio.dev/toolkits/notion) - Notion is a collaborative workspace for notes, docs, wikis, and tasks. It streamlines team knowledge, project tracking, and workflow customization in one place.
- [Airtable](https://composio.dev/toolkits/airtable) - Airtable combines the flexibility of spreadsheets with the power of a database for easy project and data management. Teams use Airtable to organize, track, and collaborate with custom views and automations.
- [Asana](https://composio.dev/toolkits/asana) - Asana is a collaborative work management platform for teams to organize and track projects. It streamlines teamwork, boosts productivity, and keeps everyone aligned on goals.
- [Google Tasks](https://composio.dev/toolkits/googletasks) - Google Tasks is a to-do list and task management tool integrated into Gmail and Google Calendar. It helps you organize, track, and complete tasks across your Google ecosystem.
- [Linear](https://composio.dev/toolkits/linear) - Linear is a modern issue tracking and project planning tool for fast-moving teams. It helps streamline workflows, organize projects, and boost productivity.
- [Jira](https://composio.dev/toolkits/jira) - Jira is Atlassian’s platform for bug tracking, issue tracking, and agile project management. It helps teams organize work, prioritize tasks, and deliver projects efficiently.
- [Clickup](https://composio.dev/toolkits/clickup) - ClickUp is an all-in-one productivity platform for managing tasks, docs, goals, and team collaboration. It streamlines project workflows so teams can work smarter and stay organized in one place.
- [Monday](https://composio.dev/toolkits/monday) - Monday.com is a customizable work management platform for project planning and collaboration. It helps teams organize tasks, automate workflows, and track progress in real time.
- [Addressfinder](https://composio.dev/toolkits/addressfinder) - Addressfinder is a data quality platform for verifying addresses, emails, and phone numbers. It helps you ensure accurate customer and contact data every time.
- [Agiled](https://composio.dev/toolkits/agiled) - Agiled is an all-in-one business management platform for CRM, projects, and finance. It helps you streamline workflows, consolidate client data, and manage business processes in one place.
- [Ascora](https://composio.dev/toolkits/ascora) - Ascora is a cloud-based field service management platform for service businesses. It streamlines scheduling, invoicing, and customer operations in one place.
- [Basecamp](https://composio.dev/toolkits/basecamp) - Basecamp is a project management and team collaboration tool by 37signals. It helps teams organize tasks, share files, and communicate efficiently in one place.
- [Beeminder](https://composio.dev/toolkits/beeminder) - Beeminder is an online goal-tracking platform that uses monetary pledges to keep you motivated. Stay accountable and hit your targets with real financial incentives.
- [Boxhero](https://composio.dev/toolkits/boxhero) - Boxhero is a cloud-based inventory management platform for SMBs, offering real-time updates, barcode scanning, and team collaboration. It helps businesses streamline stock tracking and analytics for smarter inventory decisions.
- [Breathe HR](https://composio.dev/toolkits/breathehr) - Breathe HR is cloud-based HR software for SMEs to manage employee data, absences, and performance. It simplifies HR admin, making it easy to keep employee records accurate and up to date.
- [Breeze](https://composio.dev/toolkits/breeze) - Breeze is a project management platform designed to help teams plan, track, and collaborate on projects. It streamlines workflows and keeps everyone on the same page.
- [Bugherd](https://composio.dev/toolkits/bugherd) - Bugherd is a visual feedback and bug tracking tool for websites. It helps teams and clients report website issues directly on live sites for faster fixes.
- [Canny](https://composio.dev/toolkits/canny) - Canny is a platform for managing customer feedback and feature requests. It helps teams prioritize product decisions based on real user insights.
- [Chmeetings](https://composio.dev/toolkits/chmeetings) - Chmeetings is a church management platform for events, members, donations, and volunteers. It streamlines church operations and improves community engagement.

## Frequently Asked Questions

### Do I need my own developer credentials to use Grist with Composio?

Yes, Grist requires you to configure your own API key credentials. Once set up, Composio handles secure credential storage and API request handling for you.

### Can I use multiple toolkits together?

Yes! Composio's Tool Router enables agents to use multiple toolkits. [Learn more](https://docs.composio.dev/tool-router/overview).

### Is Composio secure?

Composio is SOC 2 and ISO 27001 compliant with all data encrypted in transit and at rest. [Learn more](https://trust.composio.dev).

### What if the API changes?

Composio maintains and updates all toolkit integrations automatically, so your agents always work with the latest API versions.

---
[See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)