How to integrate Check Cherry MCP with Vercel AI SDK v6

This guide walks you through connecting Check Cherry to Vercel AI SDK v6 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 Vercel AI 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.

Get started for freeGet a demo
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 Vercel AI SDK v6 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 Vercel AI 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

OpenAI Agents SDKClaude Agent SDKClaude CodeClaude CoworkCodexOpenClawHermesCLIGoogle ADKLangChainMastra AILlamaIndexCrewAI

TL;DR

Here's what you'll learn:
  • How to set up and configure a Vercel AI SDK agent with Check Cherry integration
  • Using Composio's Tool Router to dynamically load and access Check Cherry tools
  • Creating an MCP client connection using HTTP transport
  • Building an interactive CLI chat interface with conversation history management
  • Handling tool calls and results within the Vercel AI SDK framework

What is Vercel AI SDK?

The Vercel AI SDK is a TypeScript library for building AI-powered applications. It provides tools for creating agents that can use external services and maintain conversation state.

Key features include:

  • streamText: Core function for streaming responses with real-time tool support
  • MCP Client: Built-in support for Model Context Protocol via @ai-sdk/mcp
  • Step Counting: Control multi-step tool execution with stopWhen: stepCountIs()
  • OpenAI Provider: Native integration with OpenAI models

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 you begin, make sure you have:
  • Node.js and npm installed
  • A Composio account with API key
  • An OpenAI API key
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
  • Log in to the Composio dashboard.
  • Navigate to your API settings and generate a new API key.
  • Store this key securely as you'll need it for authentication.
3

Install required dependencies

bash
npm install @ai-sdk/openai @ai-sdk/mcp @composio/core ai dotenv

First, install the necessary packages for your project.

What you're installing:

  • @ai-sdk/openai: Vercel AI SDK's OpenAI provider
  • @ai-sdk/mcp: MCP client for Vercel AI SDK
  • @composio/core: Composio SDK for tool integration
  • ai: Core Vercel AI SDK
  • dotenv: Environment variable management
4

Set up environment variables

bash
OPENAI_API_KEY=your_openai_api_key_here
COMPOSIO_API_KEY=your_composio_api_key_here
COMPOSIO_USER_ID=your_user_id_here

Create a .env file in your project root.

What's needed:

  • OPENAI_API_KEY: Your OpenAI API key for GPT model access
  • COMPOSIO_API_KEY: Your Composio API key for tool access
  • COMPOSIO_USER_ID: A unique identifier for the user session
5

Import required modules and validate environment

typescript
import "dotenv/config";
import { openai } from "@ai-sdk/openai";
import { Composio } from "@composio/core";
import * as readline from "readline";
import { streamText, type ModelMessage, stepCountIs } from "ai";
import { createMCPClient } from "@ai-sdk/mcp";

const composioAPIKey = process.env.COMPOSIO_API_KEY;
const composioUserID = process.env.COMPOSIO_USER_ID;

if (!process.env.OPENAI_API_KEY) throw new Error("OPENAI_API_KEY is not set");
if (!composioAPIKey) throw new Error("COMPOSIO_API_KEY is not set");
if (!composioUserID) throw new Error("COMPOSIO_USER_ID is not set");

const composio = new Composio({
  apiKey: composioAPIKey,
});
What's happening:
  • We're importing all necessary libraries including Vercel AI SDK's OpenAI provider and Composio
  • The dotenv/config import automatically loads environment variables
  • The MCP client import enables connection to Composio's tool server
6

Create Tool Router session and initialize MCP client

typescript
async function main() {
  // Create a tool router session for the user
  const session = await composio.create(composioUserID!, {
    toolkits: ["check_cherry"],
  });

  const mcpUrl = session.mcp.url;
What's happening:
  • We're creating a Tool Router session that gives your agent access to Check Cherry tools
  • The create method takes the user ID and specifies which toolkits should be available
  • The returned mcp object contains the URL and authentication headers needed to connect to the MCP server
  • This session provides access to all Check Cherry-related tools through the MCP protocol
7

Connect to MCP server and retrieve tools

typescript
const mcpClient = await createMCPClient({
  transport: {
    type: "http",
    url: mcpUrl,
    headers: session.mcp.headers, // Authentication headers for the Composio MCP server
  },
});

const tools = await mcpClient.tools();
What's happening:
  • We're creating an MCP client that connects to our Composio Tool Router session via HTTP
  • The mcp.url provides the endpoint, and mcp.headers contains authentication credentials
  • The type: "http" is important - Composio requires HTTP transport
  • tools() retrieves all available Check Cherry tools that the agent can use
8

Initialize conversation and CLI interface

typescript
let messages: ModelMessage[] = [];

console.log("Chat started! Type 'exit' or 'quit' to end the conversation.\n");
console.log(
  "Ask any questions related to check_cherry, like summarize my last 5 emails, send an email, etc... :)))\n",
);

const rl = readline.createInterface({
  input: process.stdin,
  output: process.stdout,
  prompt: "> ",
});

rl.prompt();
What's happening:
  • We initialize an empty messages array to maintain conversation history
  • A readline interface is created to accept user input from the command line
  • Instructions are displayed to guide the user on how to interact with the agent
9

Handle user input and stream responses with real-time tool feedback

typescript
rl.on("line", async (userInput: string) => {
  const trimmedInput = userInput.trim();

  if (["exit", "quit", "bye"].includes(trimmedInput.toLowerCase())) {
    console.log("\nGoodbye!");
    rl.close();
    process.exit(0);
  }

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

  messages.push({ role: "user", content: trimmedInput });
  console.log("\nAgent is thinking...\n");

  try {
    const stream = streamText({
      model: openai("gpt-5"),
      messages,
      tools,
      toolChoice: "auto",
      stopWhen: stepCountIs(10),
      onStepFinish: (step) => {
        for (const toolCall of step.toolCalls) {
          console.log(`[Using tool: ${toolCall.toolName}]`);
          }
          if (step.toolCalls.length > 0) {
            console.log(""); // Add space after tool calls
          }
        },
      });

      for await (const chunk of stream.textStream) {
        process.stdout.write(chunk);
      }

      console.log("\n\n---\n");

      // Get final result for message history
      const response = await stream.response;
      if (response?.messages?.length) {
        messages.push(...response.messages);
      }
    } catch (error) {
      console.error("\nAn error occurred while talking to the agent:");
      console.error(error);
      console.log(
        "\nYou can try again or restart the app if it keeps happening.\n",
      );
    } finally {
      rl.prompt();
    }
  });

  rl.on("close", async () => {
    await mcpClient.close();
    console.log("\n👋 Session ended.");
    process.exit(0);
  });
}

main().catch((err) => {
  console.error("Fatal error:", err);
  process.exit(1);
});
What's happening:
  • We use streamText instead of generateText to stream responses in real-time
  • toolChoice: "auto" allows the model to decide when to use Check Cherry tools
  • stopWhen: stepCountIs(10) allows up to 10 steps for complex multi-tool operations
  • onStepFinish callback displays which tools are being used in real-time
  • We iterate through the text stream to create a typewriter effect as the agent responds
  • The complete response is added to conversation history to maintain context
  • Errors are caught and displayed with helpful retry suggestions

Complete Code

Here's the complete code to get you started with Check Cherry and Vercel AI SDK:

typescript
import "dotenv/config";
import { openai } from "@ai-sdk/openai";
import { Composio } from "@composio/core";
import * as readline from "readline";
import { streamText, type ModelMessage, stepCountIs } from "ai";
import { createMCPClient } from "@ai-sdk/mcp";

const composioAPIKey = process.env.COMPOSIO_API_KEY;
const composioUserID = process.env.COMPOSIO_USER_ID;

if (!process.env.OPENAI_API_KEY) throw new Error("OPENAI_API_KEY is not set");
if (!composioAPIKey) throw new Error("COMPOSIO_API_KEY is not set");
if (!composioUserID) throw new Error("COMPOSIO_USER_ID is not set");

const composio = new Composio({
  apiKey: composioAPIKey,
});

async function main() {
  // Create a tool router session for the user
  const session = await composio.create(composioUserID!, {
    toolkits: ["check_cherry"],
  });

  const mcpUrl = session.mcp.url;

  const mcpClient = await createMCPClient({
    transport: {
      type: "http",
      url: mcpUrl,
      headers: session.mcp.headers, // Authentication headers for the Composio MCP server
    },
  });

  const tools = await mcpClient.tools();

  let messages: ModelMessage[] = [];

  console.log("Chat started! Type 'exit' or 'quit' to end the conversation.\n");
  console.log(
    "Ask any questions related to check_cherry, like summarize my last 5 emails, send an email, etc... :)))\n",
  );

  const rl = readline.createInterface({
    input: process.stdin,
    output: process.stdout,
    prompt: "> ",
  });

  rl.prompt();

  rl.on("line", async (userInput: string) => {
    const trimmedInput = userInput.trim();

    if (["exit", "quit", "bye"].includes(trimmedInput.toLowerCase())) {
      console.log("\nGoodbye!");
      rl.close();
      process.exit(0);
    }

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

    messages.push({ role: "user", content: trimmedInput });
    console.log("\nAgent is thinking...\n");

    try {
      const stream = streamText({
        model: openai("gpt-5"),
        messages,
        tools,
        toolChoice: "auto",
        stopWhen: stepCountIs(10),
        onStepFinish: (step) => {
          for (const toolCall of step.toolCalls) {
            console.log(`[Using tool: ${toolCall.toolName}]`);
          }
          if (step.toolCalls.length > 0) {
            console.log(""); // Add space after tool calls
          }
        },
      });

      for await (const chunk of stream.textStream) {
        process.stdout.write(chunk);
      }

      console.log("\n\n---\n");

      // Get final result for message history
      const response = await stream.response;
      if (response?.messages?.length) {
        messages.push(...response.messages);
      }
    } catch (error) {
      console.error("\nAn error occurred while talking to the agent:");
      console.error(error);
      console.log(
        "\nYou can try again or restart the app if it keeps happening.\n",
      );
    } finally {
      rl.prompt();
    }
  });

  rl.on("close", async () => {
    await mcpClient.close();
    console.log("\n👋 Session ended.");
    process.exit(0);
  });
}

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

Conclusion

You've successfully built a Check Cherry agent using the Vercel AI SDK with streaming capabilities! This implementation provides a powerful foundation for building AI applications with natural language interfaces and real-time feedback.

Key features of this implementation:

  • Real-time streaming responses for a better user experience with typewriter effect
  • Live tool execution feedback showing which tools are being used as the agent works
  • Dynamic tool loading through Composio's Tool Router with secure authentication
  • Multi-step tool execution with configurable step limits (up to 10 steps)
  • Comprehensive error handling for robust agent execution
  • Conversation history maintenance for context-aware responses

You can extend this further by adding custom error handling, implementing specific business logic, or integrating additional Composio toolkits to create multi-app workflows.
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.

FRAMEWORKS

How to build Check Cherry MCP Agent with another framework

OpenAI Agents SDK logo

OpenAI Agents SDK

Use Check Cherry MCP with OpenAI Agents SDK

Claude Agent SDK logo

Claude Agent SDK

Use Check Cherry MCP with Claude Agent SDK

Claude Code logo

Claude Code

Use Check Cherry MCP with Claude Code

Claude Cowork logo

Claude Cowork

Use Check Cherry MCP with Claude Cowork

Codex logo

Codex

Use Check Cherry MCP with Codex

OpenClaw logo

OpenClaw

Use Check Cherry MCP with OpenClaw

Hermes logo

Hermes

Use Check Cherry MCP with Hermes

CLI logo

CLI

Use Check Cherry MCP with CLI

Google ADK logo

Google ADK

Use Check Cherry MCP with Google ADK

LangChain logo

LangChain

Use Check Cherry MCP with LangChain

Mastra AI logo

Mastra AI

Use Check Cherry MCP with Mastra AI

LlamaIndex logo

LlamaIndex

Use Check Cherry MCP with LlamaIndex

CrewAI logo

CrewAI

Use Check Cherry MCP with CrewAI

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. Vercel AI SDK v6 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
Customer stories

Teams ship real agents on Composio

GET STARTED FOR FREEBOOK A DEMO
agent.aiZoomLettaGleanHubSpotAWSWabi

Karan skipped his own birthday party to fix our critical issue. It was 10pm and he diverted his Waymo to help us instead. This really sets the bar — it shows the commitment you need when users rely on your software.

Harsha Gaddipati
Harsha Gaddipati
Co-founder, Slashy

A lot of students tell us that the moment their connected tools start talking to each other inside Opennote feels almost magical. The agent just knows them, and it's immensely helped keep new users on the platform.

Abhi Arya
Abhi Arya
Co-founder, Opennote

We chose Composio over Pipedream because it delivered depth where it mattered — niche tools and tricky edge cases other platforms simply ignored. That gave us confidence to scale without compromising.

Nirman Dave
Nirman Dave
CEO, Zams

As a solo builder, shipping fast is life or death. The only way I can outcompete incumbents is by outmanoeuvring them. Getting bogged down managing agent auth would have been a death sentence.

Ryan Yu
Ryan Yu
Founder, Extra Thursday

Before Composio, adding tool integrations was slow and resource-intensive. Each one could take weeks of engineering time, and maintaining them meant constantly keeping up with API changes.

Tomisin Jenrola
Tomisin Jenrola
Founder & CEO, SwarmZero

With hands-on help from their founder, we integrated Gmail and Google Drive in just 30 minutes. This level of personal support and commitment is exactly what startups should strive for.

Jerome Leclanche
Jerome Leclanche
Co-Founder, Ingram Technologies