SIGN UPLOG IN
X (Twitter)LinkedInGitHubDiscordYouTube

How to integrate Capsule crm MCP with Vercel AI SDK v6

Connect Vercel AI SDK v6 to Capsule crm MCP. Add new company and contact details, list all open tasks for today, and more using natural language, with authentication handled for you.

Get started for freeGet a demo
Capsule crm logoCapsule crm
Oauth2Api Key

Capsule CRM is a user-friendly CRM platform for managing contacts and sales pipelines. It helps businesses organize relationships and streamline their sales process efficiently.

112 Tools

Introduction

This guide walks you through connecting Capsule crm to Vercel AI SDK v6 using the Composio tool router. By the end, you'll have a working Capsule crm agent that can manage contacts and organizations, track opportunities through pipelines, run projects, schedule tasks, and log notes through natural language commands.

This guide will help you understand how to give your Vercel AI SDK agent real control over a Capsule crm account through Composio's Capsule crm MCP server.

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

For exact tool slugs and parameter tables, see the tool catalog in the Composio docs.

Also integrate Capsule crm with

Claude CodeChatGPTClaude CoworkAntigravityOpenAI Agents SDKClaude Agent SDKCodexOpenClawHermesAtomic AgentGoogle ADKLangChainMastra AILlamaIndexCrewAIPydantic AIAutoGen

TL;DR

Here's what you'll learn:
  • How to set up and configure a Vercel AI SDK agent with Capsule crm integration
  • Using Composio's Tool Router to dynamically load and access Capsule crm 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 Capsule crm MCP server, and what's possible with it?

The Capsule crm MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Capsule CRM account. It provides structured and secure access to your contacts, sales opportunities, tasks, and more, so your agent can perform actions like managing contacts, tracking projects, organizing tasks, and retrieving sales data on your behalf.

  • Contact and party management: Effortlessly create new contacts or organizations, list all parties, and even delete records when needed—all through your agent.
  • Sales opportunity tracking: Retrieve lists of deleted or restricted sales opportunities and keep your pipeline data up to date with minimal manual work.
  • Task and activity organization: List, search, and manage your Capsule tasks, notes, and completed activities to stay on top of daily work.
  • Project and case monitoring: Quickly fetch all ongoing or filtered projects (cases) and review their status or details without ever opening the web app.
  • Team and user management: List all users on your Capsule account or pull employees for a specific organization, making team reporting and auditing a breeze.

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: ["capsule_crm"],
  });

  const mcpUrl = session.mcp.url;
What's happening:
  • We're creating a Tool Router session that gives your agent access to Capsule crm 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 Capsule crm-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 Capsule crm 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 capsule_crm, 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 Capsule crm 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 Capsule crm 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: ["capsule_crm"],
  });

  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 capsule_crm, 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 Capsule crm 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 Capsule crm action and event your agent gets out of the box.

Add Project Party

Tool to add a party (person or organisation) to a project in Capsule CRM.

Create Capsule CRM Category

Tool to create a new task category in Capsule CRM.

Create Custom Field Definition

Tool to create a new custom field definition for parties, opportunities, or projects in Capsule CRM.

Create Entry

Tool to create a new note entry in Capsule CRM.

Create Lost Reason

Tool to create a new lost reason in Capsule CRM.

Create Capsule CRM Milestone

Create a new milestone in Capsule CRM with a name, probability, and optional description for a sales pipeline stage.

Create Opportunity

Tool to create a new opportunity in Capsule CRM.

Add Party to Opportunity

Tool to add a party (person or organisation) to an opportunity in Capsule CRM.

Create Capsule CRM Party

Tool to create a Party in Capsule CRM.

Create Project

Tool to create a new project (case) in Capsule CRM.

Create Stage

Tool to create a new stage in a board in Capsule CRM.

Create Task

Tool to create a new task in Capsule CRM.

Create Capsule CRM Title

Tool to create a new custom person title in Capsule CRM.

Create Track

Tool to create a new track in Capsule CRM by applying a track definition to a project or opportunity.

Create Track Definition

Tool to create a new track definition in Capsule CRM.

Delete Board

Tool to delete (archive) a specific board in Capsule CRM.

Delete Category

Tool to delete a category from Capsule CRM.

Delete Custom Field Definition

Tool to delete a custom field definition from an entity type in Capsule CRM.

Delete Entity Tag

Tool to delete a tag from an entity type (parties, opportunities, or kases) in Capsule CRM.

Delete Entry

Tool to delete an entry (note, email, or task) from Capsule CRM.

Delete Lost Reason

Tool to delete a lost reason from Capsule CRM.

Delete Milestone

Tool to delete a specific milestone from Capsule CRM.

Delete Opportunity

Tool to delete an opportunity from Capsule CRM.

Delete Opportunity Party

Tool to remove a party (person or organisation) from an opportunity in Capsule CRM.

Delete Party

Delete a specific party (person or organisation) from Capsule CRM.

Delete Project

Tool to delete a project (case) from Capsule CRM.

Delete Project Party

Tool to remove a party (person or organisation) from a project in Capsule CRM.

Delete Stage

Tool to delete a specific stage from a board in Capsule CRM.

Delete Task

Tool to delete a specific task from Capsule CRM.

Delete Title

Tool to delete a specific title from Capsule CRM.

Delete Track

Tool to delete a specific track from Capsule CRM.

Delete Track Definition

Tool to delete a specific track definition from Capsule CRM.

Get Activity Type

Tool to get a specific activity type by ID.

Get Attachment

Tool to retrieve a specific attachment by ID from Capsule CRM.

Get Board

Tool to get a specific board by ID from Capsule CRM.

Get Category

Tool to get a specific category by ID.

Get Current User

Tool to retrieve the current authenticated user's details including id, username, name, locale, currency, status, timezone, lastLoginAt, and taskReminder settings.

Get Custom Field Definition

Tool to get a specific custom field definition by ID from Capsule CRM.

Get Entity Tag

Tool to retrieve a specific tag by ID for an entity type (parties, opportunities, or kases) in Capsule CRM.

Get Entry

Tool to retrieve a specific entry by ID.

Get Lost Reason

Tool to retrieve a specific lost reason by ID from Capsule CRM.

Get Milestone

Tool to get a specific milestone by ID from Capsule CRM.

Get Opportunity

Retrieve a specific opportunity by ID from Capsule CRM, including its value, milestone, and associated party when available.

Get Party

Retrieve one Capsule CRM person or organisation by identifier.

Get Pipeline

Tool to get a specific pipeline by ID from Capsule CRM.

Get Project

Tool to retrieve a specific project (case) by its ID from Capsule CRM.

Get Stage

Tool to get a specific stage by ID from Capsule CRM.

Get Task

Get a specific task by ID, including its description, due date, status, and returned party and owner details.

Get Track

Tool to get a specific track by ID.

Get Track Definition

Tool to get a specific track definition by ID from Capsule CRM.

Get User

Tool to get a specific user by ID.

List Activity Type Icons

Tool to list available activity type icons in Capsule CRM.

List Activity Types

Tool to list all activity types on the Capsule account.

List Boards

Tool to list all boards on the Capsule CRM account.

List Board Stages

List stages associated with a board in Capsule CRM, with optional status filtering and pagination.

List Categories

Tool to list all task categories on the Capsule account.

List Countries

Tool to list all countries on the Capsule CRM account.

List Currencies

Tool to list all available currencies on the Capsule account.

List Custom Field Definitions

Tool to list all custom field definitions for parties, opportunities, or projects (kases).

List Deleted Opportunities

Tool to list opportunities deleted or restricted since a given date.

List deleted parties

Retrieve parties deleted since a given date, with restricted parties also returned when present.

List Deleted Projects

Tool to list projects deleted or restricted since a given date.

List Entity Entries

List a page of entries, including notes, emails, and tasks, for a specific party, opportunity, or project.

List Entity Tags

Tool to list all tag definitions for a specific entity type (parties, opportunities, or kases).

List Entity Tracks

List a page of tracks applied to a specific opportunity or project, optionally including their tasks.

List Entries By Date

Tool to list notes, emails, and completed party tasks in descending order by entry date.

List Goals

Tool to list all goals on the Capsule account.

List Lost Reasons

Tool to list all lost reasons on the Capsule account.

List Milestones

List milestones on the Capsule account for pipelines or opportunities, with page and page-size controls.

List Opportunities

Tool to list all opportunities from Capsule CRM with pagination and filtering.

List Opportunity Parties

Tool to list additional parties associated with an opportunity in Capsule CRM.

List Opportunity Projects

List a page of projects (cases) associated with a specific opportunity in Capsule CRM.

List Opportunity Tasks

List tasks attached to a specific Capsule CRM opportunity.

List Organisation Employees

List a page of employees linked to a specific organisation in Capsule CRM.

List Parties

List a page of parties (contacts) on the account, with an optional changed-since filter or embedded related data.

List Party Opportunities

List a page of opportunities associated with a specific party in Capsule CRM.

List Party Projects

List a page of projects associated with a specific party in Capsule CRM.

List Party Tasks

List tasks attached to a specific Capsule CRM party.

List Pipeline Milestones

List a page of milestones for a specific pipeline in Capsule CRM, including their names, completion status, and probability.

List Pipelines

List a page of sales pipelines on the Capsule account.

List Project Parties

List a page of parties associated with a specific project in Capsule CRM, with optional embedded data.

List Projects

List projects (cases) from Capsule CRM with pagination and filtering by status, search terms, and date modified.

List REST Hooks

Tool to list all REST hook subscriptions on the Capsule CRM account.

List Site

Tool to retrieve site (account) information for the authenticated Capsule CRM account.

List Stages

Tool to list all stages on the Capsule CRM account.

List Tasks

Tool to list tasks on the Capsule account.

List Teams

List teams on the Capsule CRM account, returning their IDs, names, and creation and update timestamps.

List Titles

Tool to list all custom person titles on the Capsule account.

List Track Definitions

List a page of track definitions on the Capsule account, including track templates for opportunities or projects.

List Users

List all users on the Capsule CRM account.

Restore Board

Tool to restore a deleted board in Capsule CRM.

Run Filter Query

Tool to run structured filter queries on parties, opportunities or kases.

Search Opportunities

Tool to search for opportunities in Capsule CRM by query string.

Search Parties

Tool to search for parties (contacts/organisations) in Capsule CRM by query string.

Search Projects

Tool to search for projects (cases) in Capsule CRM by query string.

Update Capsule CRM Board

Tool to update an existing board in Capsule CRM.

Update Capsule CRM Category

Tool to update an existing category in Capsule CRM.

Update Custom Field Definition

Update the name of a custom field definition for parties, opportunities, or projects in Capsule CRM, optionally changing its data tag association.

Update Entity Tag

Tool to update an existing tag for an entity type (parties, opportunities, or kases) in Capsule CRM.

Update Entry

Tool to update an existing entry (note, email, or task) in Capsule CRM.

Update Capsule CRM Lost Reason

Update an existing Capsule CRM lost reason by ID, supplying both its name and conversion tracking setting.

Update Capsule CRM Milestone

Tool to update an existing milestone in Capsule CRM.

Update Opportunity

Tool to update an existing opportunity in Capsule CRM.

Update Capsule CRM Party

Tool to update an existing person or organisation (Party) in Capsule CRM.

Update Capsule CRM Pipeline

Tool to update an existing pipeline in Capsule CRM.

Update Project

Tool to update an existing project (case) in Capsule CRM.

Update Capsule CRM Stage

Tool to update an existing stage in Capsule CRM.

Update Task

Tool to update an existing task in Capsule CRM.

Update Capsule CRM Track

Tool to update an existing track in Capsule CRM.

Update Capsule CRM Track Definition

Tool to update an existing track definition in Capsule CRM.

Update User

Tool to update an existing user in Capsule CRM.

Upload Attachment

Tool to upload an attachment to Capsule CRM.

FRAMEWORKS

How to build Capsule crm MCP Agent with another framework

Claude Code logo

Claude Code

Use Capsule crm MCP with Claude Code

ChatGPT logo

ChatGPT

Use Capsule crm MCP with ChatGPT

Claude Cowork logo

Claude Cowork

Use Capsule crm MCP with Claude Cowork

Antigravity logo

Antigravity

Use Capsule crm MCP with Antigravity

OpenAI Agents SDK logo

OpenAI Agents SDK

Use Capsule crm MCP with OpenAI Agents SDK

Claude Agent SDK logo

Claude Agent SDK

Use Capsule crm MCP with Claude Agent SDK

Codex logo

Codex

Use Capsule crm MCP with Codex

OpenClaw logo

OpenClaw

Use Capsule crm MCP with OpenClaw

Hermes logo

Hermes

Use Capsule crm MCP with Hermes

Atomic Agent logo

Atomic Agent

Use Capsule crm MCP with Atomic Agent

Google ADK logo

Google ADK

Use Capsule crm MCP with Google ADK

LangChain logo

LangChain

Use Capsule crm MCP with LangChain

Mastra AI logo

Mastra AI

Use Capsule crm MCP with Mastra AI

LlamaIndex logo

LlamaIndex

Use Capsule crm MCP with LlamaIndex

CrewAI logo

CrewAI

Use Capsule crm MCP with CrewAI

Pydantic AI logo

Pydantic AI

Use Capsule crm MCP with Pydantic AI

AutoGen logo

AutoGen

Use Capsule crm MCP with AutoGen

FAQ

Frequently asked questions

Start with Capsule crm.It takes 30 seconds.

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

Start building