How to integrate Grafbase MCP with OpenAI Agents SDK

This guide walks you through connecting Grafbase to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Grafbase agent that can retrieve the latest audit log entry, delete a specific api key by id, get the current federated graph schema through natural language commands. This guide will help you understand how to give your OpenAI Agents SDK agent real control over a Grafbase account through Composio's Grafbase MCP server. Before we dive in, let's take a quick look at the key ideas and tools involved.

Grafbase logoGrafbase
Api Key

Grafbase is a platform for building and scaling GraphQL APIs with edge caching and unified data access. It's designed to help you deliver fast, secure, and seamless APIs—all in one place.

28 Tools

Introduction

This guide walks you through connecting Grafbase to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Grafbase agent that can retrieve the latest audit log entry, delete a specific api key by id, get the current federated graph schema through natural language commands.

This guide will help you understand how to give your OpenAI Agents SDK agent real control over a Grafbase account through Composio's Grafbase MCP server.

Before we dive in, let's take a quick look at the key ideas and tools involved.

Also integrate Grafbase 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 Grafbase
  • Configure an AI agent that can use Grafbase as a tool
  • Run a live chat session where you can ask the agent to perform Grafbase 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 Grafbase MCP server, and what's possible with it?

The Grafbase MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, and more directly to your Grafbase account. It provides structured and secure access to your GraphQL API management, so your agent can perform actions like enabling or disabling MCP, managing API keys, retrieving schemas, and working with audit logs on your behalf.

  • Enable or disable MCP server: Instantly activate or turn off the Model Context Protocol for your Grafbase project, all by agent command.
  • API key management: Let your agent securely delete existing API keys to control and rotate access as needed.
  • Schema and federation management: Retrieve federated graph schemas or remove unwanted schemas for streamlined development workflows.
  • Audit log retrieval: Fetch specific audit log entries, giving your agent the power to surface key changes or events in your Grafbase environment.
  • Extension and server configuration cleanup: Delete extension configurations or obsolete MCP server setups to keep your backend lean and secure.

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 Grafbase 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 Grafbase.
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 Grafbase
const session = await composio.create(userId as string, {
  toolkits: ['grafbase'],
});
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 grafbase.
  • The router checks the user's Grafbase connection and prepares the MCP endpoint.
  • The returned session.mcp.url is the MCP URL that your agent will use to access Grafbase.
  • This approach keeps things lightweight and lets the agent request Grafbase 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 Grafbase. Help users perform Grafbase 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 Grafbase 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 Grafbase 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 Grafbase.
  • 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 Grafbase 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: ['grafbase'],
  });
  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 Grafbase. Help users perform Grafbase 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 Grafbase MCP with OpenAI Agents SDK to build a functional AI agent that can interact with Grafbase.

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 Grafbase action and event your agent gets out of the box.

Add Zitadel Redirect URI

Add a redirect URI to Zitadel OAuth configuration in Grafbase.

Assign Team Role

Tool to assign a role to a team member in Grafbase.

Delete Grafbase API Key

Delete an existing Grafbase API key (access token) by ID.

Delete Grafbase Audit Log

Tool to delete a specific Grafbase audit log entry.

Delete Extension

Tool to delete a Grafbase extension configuration by its unique ID.

Delete MCP Server

Tool to delete a Grafbase MCP server configuration by its unique ID.

Delete Grafbase Subgraph

Tool to delete a subgraph from a Grafbase federated graph.

Delete Schema Check

Attempt to delete a schema check from the Grafbase platform.

Delete Grafbase Team

Tool to delete a team from the Grafbase organization.

Disable MCP Server

Disable the Model Context Protocol (MCP) server for a Grafbase project.

Enable Grafbase MCP Server

Enable the Model Context Protocol (MCP) server on a Grafbase gateway.

Get Grafbase Audit Log

Tool to retrieve a specific Grafbase audit log entry by searching organization activity.

Get Extension by Name

Tool to retrieve a Grafbase extension by its name.

Get Extension Version By Name And Version

Tool to retrieve details of a specific Grafbase extension version by name and version.

Get Federated Schema

Retrieves the composed federated graph schema from Grafbase in SDL format.

Get Grafbase Invitation

Tool to retrieve details about a specific Grafbase invitation by ID.

Get Notifications Inbox Messages

Tool to retrieve notifications inbox messages for the authenticated Grafbase user.

Get Grafbase Schema Check

Retrieve details of a specific schema check by its ID.

Get Subgraph Schema

Retrieves the GraphQL SDL schema for a specific subgraph by name.

List API Keys

List all API keys (access tokens) for the authenticated Grafbase user.

List Grafbase Audit Logs

Tool to list audit logs for Grafbase organizations.

List Extensions

Tool to list all extensions configured for a Grafbase project.

List MCP Servers

Check MCP server configuration status for a Grafbase gateway.

List Grafbase Schema Checks

List schema checks for a Grafbase graph.

List Grafbase Schemas

Tool to list all schemas in the Grafbase schema registry.

List Grafbase Subgraphs

Tool to list published subgraphs in your Grafbase federated graphs.

Mark Notifications as Read

Tool to mark Grafbase notifications as read.

Remove Graph Owner

Tool to remove an owner from a Grafbase graph.

FAQ

Frequently asked questions

With a standalone Grafbase MCP server, the agents and LLMs can only access a fixed set of Grafbase tools tied to that server. However, with the Composio Tool Router, agents can dynamically load tools from Grafbase 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 Grafbase tools.

Yes, absolutely. You can configure which Grafbase 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 Grafbase data and credentials are handled as safely as possible.

Start with Grafbase.It takes 30 seconds.

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

Start building