How to integrate Botstar MCP with OpenAI Agents SDK

This guide walks you through connecting Botstar to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Botstar agent that can open live chat widget for new visitor, update user profile in current chat session, retrieve chatbot application id for setup through natural language commands. This guide will help you understand how to give your OpenAI Agents SDK agent real control over a Botstar account through Composio's Botstar MCP server. Before we dive in, let's take a quick look at the key ideas and tools involved.

Botstar logoBotstar
Api Key

BotStar is a comprehensive chatbot platform for designing, developing, and training chatbots visually on Messenger and websites. It helps businesses automate conversations and customer interactions without coding.

31 Tools

Introduction

This guide walks you through connecting Botstar to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Botstar agent that can open live chat widget for new visitor, update user profile in current chat session, retrieve chatbot application id for setup through natural language commands.

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

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

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

The Botstar MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Botstar account. It provides structured and secure access to your chatbot operations, so your agent can perform actions like managing live chat sessions, updating user details, retrieving app parameters, and sending data between webviews and your bot—all on your behalf.

  • Live chat session control: Programmatically open, close, or reinitialize the Botstar live chat widget to manage user interactions in real time.
  • Automated user profile updates: Let your agent update user details and profile attributes during an active chatbot conversation for a more personalized experience.
  • Webview data exchange: Seamlessly send responses from webviews back to the chatbot or retrieve parameters passed from the bot to your webview for dynamic content handling.
  • Custom callback registration: Set up onOpen and onClose event handlers so your agent can trigger actions whenever users interact with the chat window.
  • Application ID and configuration retrieval: Fetch essential Botstar application IDs and parameters for smooth widget initialization and advanced bot customization.

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

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

Create Bot

Tool to create a new bot in BotStar.

Create Bot Attribute

Tool to create a new bot attribute in BotStar.

Create CMS Entity

Tool to create a CMS entity in BotStar with a name and optional fields.

Create Entity Fields

Tool to create entity field(s) in BotStar CMS.

Create Entity Item

Tool to create a new entity item in BotStar CMS.

Create User Attributes

Tool to create custom user attributes in BotStar.

Delete Bot Attribute

Tool to delete a bot attribute by ID.

Delete CMS Entity

Tool to delete a CMS entity by ID.

Delete Entity Fields

Tool to delete entity field(s) from a CMS entity.

Delete Entity Item

Tool to delete an entity item from a CMS entity.

Get Bot

Tool to get your bot by bot ID.

Get BotStar Application IDs

Tool to retrieve the BotStar application ID (`appId`).

Get CMS Entity

Tool to get a specific CMS entity by ID.

Get Entity Item

Tool to retrieve a specific item from a CMS entity with all field values.

List Bot Attributes

Tool to get all bot attributes from BotStar.

List Bots

Tool to get your list of bots.

List CMS Entities

Tool to retrieve all CMS entities for a bot.

List Entity Items

Tool to retrieve all entity items with pagination support.

Livechat boot

Tool to reinitialize the live chat widget with provided data.

Close BotStar Livechat Widget

Tool to hide the live chat window.

BotStar LiveChat onClose Callback

Tool to register a callback when the chat window is closed.

Livechat on open

Tool to register a callback when the chat window is opened.

Livechat open

Tool to show the live chat window.

Livechat update

Tool to update user details on the current live chat session.

Publish Bot to Live

Tool to publish a bot to live.

Update Bot Attribute

Tool to update a bot attribute in BotStar.

Update CMS Entity

Tool to update a CMS entity in BotStar.

Update Entity Fields

Tool to update entity field(s) in BotStar CMS.

Update Entity Item

Tool to update a CMS entity item in BotStar.

Get BotStar Webview Parameter

Tool to retrieve a parameter value passed from the BotStar chatbot to the webview.

Webview send response

Tool to send data from the webview back to the BotStar chatbot.

FAQ

Frequently asked questions

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

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

Start with Botstar.It takes 30 seconds.

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

Start building