# How to integrate Grist MCP with Autogen ```json { "title": "How to integrate Grist MCP with Autogen", "toolkit": "Grist", "toolkit_slug": "grist", "framework": "AutoGen", "framework_slug": "autogen", "url": "https://composio.dev/toolkits/grist/framework/autogen", "markdown_url": "https://composio.dev/toolkits/grist/framework/autogen.md", "updated_at": "2026-05-12T10:14:24.273Z" } ``` ## Introduction This guide walks you through connecting Grist to AutoGen using the Composio tool router. By the end, you'll have a working Grist agent that can add new sales data to q2 table, create a document for project planning, delete outdated rows from inventory sheet through natural language commands. This guide will help you understand how to give your AutoGen agent real control over a Grist account through Composio's Grist MCP server. Before we dive in, let's take a quick look at the key ideas and tools involved. ## Also integrate 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) - [CLI](https://composio.dev/toolkits/grist/framework/cli) - [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) ## TL;DR Here's what you'll learn: - Get and set up your OpenAI and Composio API keys - Install the required dependencies for Autogen and Composio - Initialize Composio and create a Tool Router session for Grist - Wire that MCP URL into Autogen using McpWorkbench and StreamableHttpServerParams - Configure an Autogen AssistantAgent that can call Grist tools - Run a live chat loop where you ask the agent to perform Grist operations ## What is AutoGen? Autogen is a framework for building multi-agent conversational AI systems from Microsoft. It enables you to create agents that can collaborate, use tools, and maintain complex workflows. Key features include: - Multi-Agent Systems: Build collaborative agent workflows - MCP Workbench: Native support for Model Context Protocol tools - Streaming HTTP: Connect to external services through streamable HTTP - AssistantAgent: Pre-built agent class for tool-using assistants ## What is the Grist MCP server, and what's possible with it? The Grist MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Grist account. It provides structured and secure access to your spreadsheets and documents, so your agent can perform actions like adding records, creating tables, managing documents, and handling attachments on your behalf. - Automated data entry and record management: Instruct your agent to add, update, or delete records in specific Grist tables, streamlining your workflows and reducing manual input. - Table and document creation: Let your agent create new tables or entire documents in your workspaces, helping you quickly set up and expand your data structures as your needs grow. - Attachment and file management: Ask your agent to remove unwanted attachments from Grist documents, keeping your files organized and storage efficient. - Custom webhook integration: Have your agent register or delete webhooks for documents, enabling real-time notifications and integrations with other tools or services you rely on. - User and access provisioning via SCIM: Direct your agent to create or delete SCIM users as needed, making it easy to manage who has access to your Grist environment. ## 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. ## Creating MCP Server - Stand-alone vs Composio SDK The Grist MCP server is an implementation of the Model Context Protocol that connects your AI agents and assistants directly to Grist. Instead of manually wiring Grist APIs, OAuth, and scopes yourself, you get a structured, tool-based interface that an LLM can call safely. With Composio's managed implementation, you don't have to create your own developer app. For production, if you're building an end product, we recommend using your own credentials. The managed server helps you prototype fast and go from 0-1 faster. ## Step-by-step Guide ### 1. Prerequisites You will need: - A Composio API key - An OpenAI API key (used by Autogen's OpenAIChatCompletionClient) - A Grist account you can connect to Composio - Some basic familiarity with Autogen and Python async ### 1. Getting API Keys for OpenAI and Composio OpenAI API Key - Go to the [OpenAI dashboard](https://platform.openai.com/settings/organization/api-keys) and create an API key. You'll need credits to use the models, or you can connect to another model provider. - Keep the API key safe. Composio API Key - Log in to the [Composio dashboard](https://dashboard.composio.dev?utm_source=toolkits&utm_medium=framework_docs). - Navigate to your API settings and generate a new API key. - Store this key securely as you'll need it for authentication. ### 2. Install dependencies Install Composio, Autogen extensions, and dotenv. What's happening: - composio connects your agent to Grist via MCP - autogen-agentchat provides the AssistantAgent class - autogen-ext-openai provides the OpenAI model client - autogen-ext-tools provides MCP workbench support ```bash pip install composio python-dotenv pip install autogen-agentchat autogen-ext-openai autogen-ext-tools ``` ### 3. Set up environment variables Create a .env file in your project folder. What's happening: - COMPOSIO_API_KEY is required to talk to Composio - OPENAI_API_KEY is used by Autogen's OpenAI client - USER_ID is how Composio identifies which user's Grist connections to use ```bash COMPOSIO_API_KEY=your-composio-api-key OPENAI_API_KEY=your-openai-api-key USER_ID=your-user-identifier@example.com ``` ### 4. Import dependencies and create Tool Router session What's happening: - load_dotenv() reads your .env file - Composio(api_key=...) initializes the SDK - create(...) creates a Tool Router session that exposes Grist tools - session.mcp.url is the MCP endpoint that Autogen will connect to ```python import asyncio import os from dotenv import load_dotenv from composio import Composio from autogen_agentchat.agents import AssistantAgent from autogen_ext.models.openai import OpenAIChatCompletionClient from autogen_ext.tools.mcp import McpWorkbench, StreamableHttpServerParams load_dotenv() async def main(): # Initialize Composio and create a Grist session composio = Composio(api_key=os.getenv("COMPOSIO_API_KEY")) session = composio.create( user_id=os.getenv("USER_ID"), toolkits=["grist"] ) url = session.mcp.url ``` ### 5. Configure MCP parameters for Autogen Autogen expects parameters describing how to talk to the MCP server. That is what StreamableHttpServerParams is for. What's happening: - url points to the Tool Router MCP endpoint from Composio - timeout is the HTTP timeout for requests - sse_read_timeout controls how long to wait when streaming responses - terminate_on_close=True cleans up the MCP server process when the workbench is closed ```python # Configure MCP server parameters for Streamable HTTP server_params = StreamableHttpServerParams( url=url, timeout=30.0, sse_read_timeout=300.0, terminate_on_close=True, headers={"x-api-key": os.getenv("COMPOSIO_API_KEY")} ) ``` ### 6. Create the model client and agent What's happening: - OpenAIChatCompletionClient wraps the OpenAI model for Autogen - McpWorkbench connects the agent to the MCP tools - AssistantAgent is configured with the Grist tools from the workbench ```python # Create model client model_client = OpenAIChatCompletionClient( model="gpt-5", api_key=os.getenv("OPENAI_API_KEY") ) # Use McpWorkbench as context manager async with McpWorkbench(server_params) as workbench: # Create Grist assistant agent with MCP tools agent = AssistantAgent( name="grist_assistant", description="An AI assistant that helps with Grist operations.", model_client=model_client, workbench=workbench, model_client_stream=True, max_tool_iterations=10 ) ``` ### 7. Run the interactive chat loop What's happening: - The script prompts you in a loop with You: - Autogen passes your input to the model, which decides which Grist tools to call via MCP - agent.run_stream(...) yields streaming messages as the agent thinks and calls tools - Typing exit, quit, or bye ends the loop ```python print("Chat started! Type 'exit' or 'quit' to end the conversation.\n") print("Ask any Grist related question or task to the agent.\n") # Conversation loop while True: user_input = input("You: ").strip() if user_input.lower() in ["exit", "quit", "bye"]: print("\nGoodbye!") break if not user_input: continue print("\nAgent is thinking...\n") # Run the agent with streaming try: response_text = "" async for message in agent.run_stream(task=user_input): if hasattr(message, "content") and message.content: response_text = message.content # Print the final response if response_text: print(f"Agent: {response_text}\n") else: print("Agent: I encountered an issue processing your request.\n") except Exception as e: print(f"Agent: Sorry, I encountered an error: {str(e)}\n") ``` ## Complete Code ```python import asyncio import os from dotenv import load_dotenv from composio import Composio from autogen_agentchat.agents import AssistantAgent from autogen_ext.models.openai import OpenAIChatCompletionClient from autogen_ext.tools.mcp import McpWorkbench, StreamableHttpServerParams load_dotenv() async def main(): # Initialize Composio and create a Grist session composio = Composio(api_key=os.getenv("COMPOSIO_API_KEY")) session = composio.create( user_id=os.getenv("USER_ID"), toolkits=["grist"] ) url = session.mcp.url # Configure MCP server parameters for Streamable HTTP server_params = StreamableHttpServerParams( url=url, timeout=30.0, sse_read_timeout=300.0, terminate_on_close=True, headers={"x-api-key": os.getenv("COMPOSIO_API_KEY")} ) # Create model client model_client = OpenAIChatCompletionClient( model="gpt-5", api_key=os.getenv("OPENAI_API_KEY") ) # Use McpWorkbench as context manager async with McpWorkbench(server_params) as workbench: # Create Grist assistant agent with MCP tools agent = AssistantAgent( name="grist_assistant", description="An AI assistant that helps with Grist operations.", model_client=model_client, workbench=workbench, model_client_stream=True, max_tool_iterations=10 ) print("Chat started! Type 'exit' or 'quit' to end the conversation.\n") print("Ask any Grist related question or task to the agent.\n") # Conversation loop while True: user_input = input("You: ").strip() if user_input.lower() in ['exit', 'quit', 'bye']: print("\nGoodbye!") break if not user_input: continue print("\nAgent is thinking...\n") # Run the agent with streaming try: response_text = "" async for message in agent.run_stream(task=user_input): if hasattr(message, 'content') and message.content: response_text = message.content # Print the final response if response_text: print(f"Agent: {response_text}\n") else: print("Agent: I encountered an issue processing your request.\n") except Exception as e: print(f"Agent: Sorry, I encountered an error: {str(e)}\n") if __name__ == "__main__": asyncio.run(main()) ``` ## Conclusion You now have an Autogen assistant wired into Grist through Composio's Tool Router and MCP. From here you can: - Add more toolkits to the toolkits list, for example notion or hubspot - Refine the agent description to point it at specific workflows - Wrap this script behind a UI, Slack bot, or internal tool Once the pattern is clear for Grist, you can reuse the same structure for other MCP-enabled apps with minimal code changes. ## How to build Grist MCP Agent with another framework - [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) - [CLI](https://composio.dev/toolkits/grist/framework/cli) - [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) ## 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 ### What are the differences in Tool Router MCP and Grist MCP? With a standalone Grist MCP server, the agents and LLMs can only access a fixed set of Grist tools tied to that server. However, with the Composio Tool Router, agents can dynamically load tools from Grist and many other apps based on the task at hand, all through a single MCP endpoint. ### Can I use Tool Router MCP with Autogen? Yes, you can. Autogen fully supports MCP integration. You get structured tool calling, message history handling, and model orchestration while Tool Router takes care of discovering and serving the right Grist tools. ### Can I manage the permissions and scopes for Grist while using Tool Router? Yes, absolutely. You can configure which Grist scopes and actions are allowed when connecting your account to Composio. You can also bring your own OAuth credentials or API configuration so you keep full control over what the agent can do. ### How safe is my data with Composio Tool Router? All sensitive data such as tokens, keys, and configuration is fully encrypted at rest and in transit. Composio is SOC 2 Type 2 compliant and follows strict security practices so your Grist data and credentials are handled as safely as possible. --- [See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)