How to integrate Grist MCP with OpenAI Agents SDK

This guide walks you through connecting Grist to the OpenAI Agents SDK 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 OpenAI Agents SDK 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.

Grist logoGrist
Api Key

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

30 Tools

Introduction

This guide walks you through connecting Grist to the OpenAI Agents SDK 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 OpenAI Agents SDK 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

TL;DR

Here's what you'll learn:
  • Get and set up your OpenAI and Composio API keys
  • Install the necessary dependencies
  • Initialize Composio and create a Tool Router session for Grist
  • Configure an AI agent that can use Grist as a tool
  • Run a live chat session where you can ask the agent to perform Grist operations

What is OpenAI Agents SDK?

The OpenAI Agents SDK is a lightweight framework for building AI agents that can use tools and maintain conversation state. It provides a simple interface for creating agents with hosted MCP tool support.

Key features include:

  • Hosted MCP Tools: Connect to external services through hosted MCP endpoints
  • SQLite Sessions: Persist conversation history across interactions
  • Simple API: Clean interface with Agent, Runner, and tool configuration
  • Streaming Support: Real-time response streaming for interactive applications

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.

What is the Composio tool router, and how does it fit here?

What is Composio SDK?

Composio's Composio SDK helps agents find the right tools for a task at runtime. You can plug in multiple toolkits (like Gmail, HubSpot, and GitHub), and the agent will identify the relevant app and action to complete multi-step workflows. This can reduce token usage and improve the reliability of tool calls. Read more here: Getting started with Composio SDK

The tool router generates a secure MCP URL that your agents can access to perform actions.

How the Composio SDK works

The Composio SDK follows a three-phase workflow:

  1. Discovery: Searches for tools matching your task and returns relevant toolkits with their details.
  2. Authentication: Checks for active connections. If missing, creates an auth config and returns a connection URL via Auth Link.
  3. Execution: Executes the action using the authenticated connection.

Step-by-step Guide

Step by step09 STEPS
1

Prerequisites

Before starting, make sure you have:
  • Composio API Key and OpenAI API Key
  • Primary know-how of OpenAI Agents SDK
  • A live Grist project
  • Some knowledge of Python or Typescript
2

Getting API Keys for OpenAI and Composio

OpenAI API Key
  • Go to the OpenAI dashboard 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
3

Install dependencies

npm install @composio/openai-agents @openai/agents dotenv

Install the Composio SDK and the OpenAI Agents SDK.

4

Set up environment variables

bash
OPENAI_API_KEY=sk-...your-api-key
COMPOSIO_API_KEY=your-api-key
USER_ID=composio_user@gmail.com

Create a .env file and add your OpenAI and Composio API keys.

5

Import dependencies

import 'dotenv/config';
import { Composio } from '@composio/core';
import { OpenAIAgentsProvider } from '@composio/openai-agents';
import { Agent, hostedMcpTool, run, OpenAIConversationsSession } from '@openai/agents';
import * as readline from 'readline';
What's happening:
  • You're importing all necessary libraries.
  • The Composio and OpenAIAgentsProvider classes are imported to connect your OpenAI agent to Composio tools like Grist.
6

Set up the Composio instance

dotenv.config();

const composioApiKey = process.env.COMPOSIO_API_KEY;
const userId = process.env.USER_ID;

if (!composioApiKey) {
  throw new Error('COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key');
}
if (!userId) {
  throw new Error('USER_ID is not set');
}

// Initialize Composio
const composio = new Composio({
  apiKey: composioApiKey,
  provider: new OpenAIAgentsProvider(),
});
What's happening:
  • dotenv.config() loads your .env file so COMPOSIO_API_KEY and USER_ID are available as environment variables.
  • Creating a Composio instance using the API Key and OpenAIAgentsProvider class.
7

Create a Tool Router session

// Create Tool Router session for Grist
const session = await composio.create(userId as string, {
  toolkits: ['grist'],
});
const mcpUrl = session.mcp.url;

What is happening:

  • You give the Tool Router the user id and the toolkits you want available. Here, it is only grist.
  • The router checks the user's Grist connection and prepares the MCP endpoint.
  • The returned session.mcp.url is the MCP URL that your agent will use to access Grist.
  • This approach keeps things lightweight and lets the agent request Grist tools only when needed during the conversation.
8

Configure the agent

// Configure agent with MCP tool
const agent = new Agent({
  name: 'Assistant',
  model: 'gpt-5',
  instructions:
    'You are a helpful assistant that can access Grist. Help users perform Grist operations through natural language.',
  tools: [
    hostedMcpTool({
      serverLabel: 'tool_router',
      serverUrl: mcpUrl,
      headers: { 'x-api-key': composioApiKey },
      requireApproval: 'never',
    }),
  ],
});
What's happening:
  • We're creating an Agent instance with a name, model (gpt-5), and clear instructions about its purpose.
  • The agent's instructions tell it that it can access Grist and help with queries, inserts, updates, authentication, and fetching database information.
  • The tools array includes a hostedMcpTool that connects to the MCP server URL we created earlier.
  • The headers object includes the Composio API key for secure authentication with the MCP server.
  • requireApproval: 'never' means the agent can execute Grist operations without asking for permission each time, making interactions smoother.
9

Start chat loop and handle conversation

// Keep conversation state across turns
const conversationSession = new OpenAIConversationsSession();

// Simple CLI
const rl = readline.createInterface({
  input: process.stdin,
  output: process.stdout,
  prompt: 'You: ',
});

console.log('\nComposio Tool Router session created.');
console.log('\nChat started. Type your requests below.');
console.log("Commands: 'exit', 'quit', or 'q' to end\n");

try {
  const first = await run(agent, 'What can you help me with?', { session: conversationSession });
  console.log(`Assistant: ${first.finalOutput}\n`);
} catch (e) {
  console.error('Error:', e instanceof Error ? e.message : e, '\n');
}

rl.prompt();

rl.on('line', async (userInput) => {
  const text = userInput.trim();

  if (['exit', 'quit', 'q'].includes(text.toLowerCase())) {
    console.log('Goodbye!');
    rl.close();
    process.exit(0);
  }

  if (!text) {
    rl.prompt();
    return;
  }

  try {
    const result = await run(agent, text, { session: conversationSession });
    console.log(`\nAssistant: ${result.finalOutput}\n`);
  } catch (e) {
    console.error('Error:', e instanceof Error ? e.message : e, '\n');
  }

  rl.prompt();
});

rl.on('close', () => {
  console.log('\n👋 Session ended.');
  process.exit(0);
});
What's happening:
  • The program prints a session URL that you visit to authorize Grist.
  • After authorization, the chat begins.
  • Each message you type is processed by the agent using run().
  • The responses are printed to the console.
  • Typing exit, quit, or q cleanly ends the chat.

Complete Code

Here's the complete code to get you started with Grist and OpenAI Agents SDK:

import 'dotenv/config';
import { Composio } from '@composio/core';
import { OpenAIAgentsProvider } from '@composio/openai-agents';
import { Agent, hostedMcpTool, run, OpenAIConversationsSession } from '@openai/agents';
import * as readline from 'readline';

const composioApiKey = process.env.COMPOSIO_API_KEY;
const userId = process.env.USER_ID;

if (!composioApiKey) {
  throw new Error('COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key');
}
if (!userId) {
  throw new Error('USER_ID is not set');
}

// Initialize Composio
const composio = new Composio({
  apiKey: composioApiKey,
  provider: new OpenAIAgentsProvider(),
});

async function main() {
  // Create Tool Router session
  const session = await composio.create(userId as string, {
    toolkits: ['grist'],
  });
  const mcpUrl = session.mcp.url;

  // Configure agent with MCP tool
  const agent = new Agent({
    name: 'Assistant',
    model: 'gpt-5',
    instructions:
      'You are a helpful assistant that can access Grist. Help users perform Grist operations through natural language.',
    tools: [
      hostedMcpTool({
        serverLabel: 'tool_router',
        serverUrl: mcpUrl,
        headers: { 'x-api-key': composioApiKey },
        requireApproval: 'never',
      }),
    ],
  });

  // Keep conversation state across turns
  const conversationSession = new OpenAIConversationsSession();

  // Simple CLI
  const rl = readline.createInterface({
    input: process.stdin,
    output: process.stdout,
    prompt: 'You: ',
  });

  console.log('\nComposio Tool Router session created.');
  console.log('\nChat started. Type your requests below.');
  console.log("Commands: 'exit', 'quit', or 'q' to end\n");

  try {
    const first = await run(agent, 'What can you help me with?', { session: conversationSession });
    console.log(`Assistant: ${first.finalOutput}\n`);
  } catch (e) {
    console.error('Error:', e instanceof Error ? e.message : e, '\n');
  }

  rl.prompt();

  rl.on('line', async (userInput) => {
    const text = userInput.trim();

    if (['exit', 'quit', 'q'].includes(text.toLowerCase())) {
      console.log('Goodbye!');
      rl.close();
      process.exit(0);
    }

    if (!text) {
      rl.prompt();
      return;
    }

    try {
      const result = await run(agent, text, { session: conversationSession });
      console.log(`\nAssistant: ${result.finalOutput}\n`);
    } catch (e) {
      console.error('Error:', e instanceof Error ? e.message : e, '\n');
    }

    rl.prompt();
  });

  rl.on('close', () => {
    console.log('\nSession ended.');
    process.exit(0);
  });
}

main().catch((err) => {
  console.error('Fatal error:', err);
  process.exit(1);
});

Conclusion

This was a starter code for integrating Grist MCP with OpenAI Agents SDK to build a functional AI agent that can interact with Grist.

Key features:

  • Hosted MCP tool integration through Composio's Tool Router
  • SQLite session persistence for conversation history
  • Simple async chat loop for interactive testing
You can extend this by adding more toolkits, implementing custom business logic, or building a web interface around the agent.
TOOLS

Supported Tools

Every Grist action and event your agent gets out of the box.

Add Records

Add one or more records to a Grist table.

Create Document

Creates a new Grist document in a specified workspace.

Create SCIM User

Tool to create a new SCIM user.

Create Table

Tool to create tables in a document.

Create Document Webhook

Tool to create a new webhook for a specified document.

Remove Unused Attachments

Remove unused attachments from a Grist document to free up storage space.

Delete Column

Tool to delete a column from a Grist document table.

Delete Grist Table Records

Tool to delete records from a specified Grist table.

Delete SCIM User

Delete a user from the Grist organization by their numeric user ID.

Delete Webhook

Permanently removes a webhook from a Grist document.

Download All Attachments Archive

Download all attachments from a Grist document as a single archive file (.

Download Attachment

Download a file attachment from a Grist document.

Fetch Document Metadata

Tool to fetch metadata for a specified Grist document.

Fetch Table Metadata

Tool to retrieve metadata for a specified table in a Grist document.

Get Org Access

Retrieves the list of users who have access to a Grist organization along with their access roles (owners, editors, viewers).

Get Users

Tool to retrieve a list of users via SCIM v2.

List Attachments

Tool to list all attachments in a Grist document.

List Columns

Tool to list all columns in a specified Grist table.

List Organizations

Tool to list all organizations accessible to the authenticated user.

List Records

Tool to retrieve records from a specified table within a Grist document.

List Tables

Tool to list all tables within a specified document.

List Webhooks

List all webhooks configured for a Grist document.

List Workspaces

Tool to list all workspaces and documents accessible to the authenticated user on the current site.

Run SQL Query

Tool to execute a read-only SQL SELECT query on a Grist document.

Update Column Metadata

Updates metadata (label, type, description, formula, etc.

Update Document Metadata

Tool to update metadata for a specified Grist document.

Update Records

Update existing records in a Grist table by their row IDs.

Update Table Metadata

Update metadata properties for a table in a Grist document.

Update Webhook

Update an existing webhook configuration for a Grist document.

Upload Attachment

Upload one or more file attachments to a Grist document.

FAQ

Frequently asked questions

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.

Yes, you can. OpenAI Agents SDK 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.

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.

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.

Start with Grist.It takes 30 seconds.

Managed auth, hosted MCP servers, and every Grist tool your agent needs.Free to start.

Start building