How to integrate Check Cherry MCP with OpenAI Agents SDK

This guide walks you through connecting Check Cherry to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Check Cherry agent that can list your appointments, check event availability, create appointments, track expenses, and view reports through natural language commands. This guide will help you understand how to give your OpenAI Agents SDK agent real control over a Check Cherry account through Composio's Check Cherry MCP server. Before we dive in, let's take a quick look at the key ideas and tools involved.

Check Cherry logoCheck Cherry
Api Key

Check Cherry is a business management platform for photography and event service companies. It helps teams manage leads, bookings, appointments, offerings, payments, and workflows in one place.

25 Tools

Introduction

This guide walks you through connecting Check Cherry to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Check Cherry agent that can list your appointments, check event availability, create appointments, track expenses, and view reports through natural language commands.

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

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

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

The Check Cherry MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Check Cherry account. It provides structured and secure access to your leads, bookings, appointments, offerings, payments, expenses, questionnaires, and business reports, so your agent can manage schedules, review clients and events, track finances, update questionnaires, and check availability on your behalf.

  • Lead and booking management: Have your agent search leads, review proposals and confirmed bookings, and find package bookings by event date.
  • Appointments and availability: Let the agent check package availability, find open appointment times, schedule staff appointments for guests, and remove appointments from the active calendar.
  • Payments and expense tracking: Direct your agent to review event payments and refunds, record business expenses, update expense details, classify costs, or remove outdated expense records.
  • Questionnaire coordination: Instruct your agent to attach questionnaire templates to bookings, review questions and responses, update answers, and remove questionnaires when needed.
  • Offerings and business reporting: Have your agent review services, package groups, packages, and add-ons, then retrieve reports covering bookings, leads, payments, proposals, or projected revenue.

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

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

Attach Questionnaire

Copy a questionnaire template onto a proposal or confirmed booking.

Check Event Availability

Check whether a package can be booked on one date or across a date range.

Create Appointment

Create a staff appointment for a guest at a specific date, time, and duration; this changes the business calendar.

Create Expense

Record a business expense with its payment date, amount, reference, payee, and optional event and category links.

Delete Appointment

Soft-delete one appointment so it no longer appears in active business calendar records; Check Cherry retains the deleted record.

Delete Expense

Soft-delete one business expense so it no longer appears in listings; Check Cherry retains the record for record-keeping.

Get Appointment

Return full guest, scheduling, and assignment details for one appointment.

Get Event

Return full details for one proposal or confirmed booking by event ID.

Get Lead

Return full details for one lead by ID.

Get Questionnaire

Return one questionnaire with its questions, current answers, and completion state.

Get Report

Return one time-bucketed Check Cherry business report for bookings, leads, payments, proposals, or projected revenue.

List Appointments

Search staff appointments by date, assignee, brand, cancellation state, time direction, or text, returning one page.

List Appointment Slots

Return available appointment times for one staff member and appointment calendar on a selected date.

List Event Bookings

List package bookings attached to events within an optional event-date range, returning one page and a continuation cursor.

List Events

Search proposals and confirmed bookings with date, status, client, staff, payment, and workflow filters, returning one page.

List Expense Categories

Return the expense categories available for classifying business expenses.

List Expenses

Search business expenses by event, category, payment date, text, and sort order, returning one page.

List Leads

Search leads by exact email or contact and event text, returning one page of CRM records.

List Offerings

List one Check Cherry catalog resource: services, package groups, packages, or add-ons.

List Payments

List event payment records, including received payments and refunds, by event or payment date; returns one page with monetary values in Check Cherry's original representations.

List Questionnaires

List questionnaires attached to one event booking.

List Questionnaire Templates

Return questionnaire templates that can be attached to an event booking.

Remove Questionnaire

Detach one questionnaire from its event booking and delete its collected answers; the source questionnaire template is unchanged.

Update Expense

Change selected fields on an existing business expense.

Update Questionnaire Answers

Update answers on a standard questionnaire.

FAQ

Frequently asked questions

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

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

Start with Check Cherry.It takes 30 seconds.

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

Start building