How to integrate Lyzr MCP with OpenAI Agents SDK

This guide walks you through connecting Lyzr to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Lyzr agent that can create ai agents, chat with your agents, schedule workflows, manage agent memory, and run ai checks through natural language commands. This guide will help you understand how to give your OpenAI Agents SDK agent real control over a Lyzr account through Composio's Lyzr MCP server. Before we dive in, let's take a quick look at the key ideas and tools involved.

Lyzr logoLyzr
Api Key

Lyzr is an AI agent platform for building, running, evaluating, and managing agents. It helps teams ship safer AI workflows with Studio services for memory, voice, simulations, and knowledge bases.

22 Tools

Introduction

This guide walks you through connecting Lyzr to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Lyzr agent that can create ai agents, chat with your agents, schedule workflows, manage agent memory, and run ai checks through natural language commands.

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

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

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

The Lyzr MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Lyzr account. It provides structured and secure access to your agents, memory, knowledge bases, Responsible AI policies, simulations, schedules, workflows, and voice records, so your agent can create and manage agents, run conversations, search stored knowledge, review safety results, and monitor operations on your behalf.

  • Agent creation and conversations: Have your agent create single-task agents with chosen models and instructions, activate or deactivate them, run conversations, inspect their setup, or delete them.
  • Memory and knowledge retrieval: Let the agent store conversation messages, search memories across sessions, clear session history, inspect knowledge bases, and retrieve relevant documents.
  • Responsible AI and simulation review: Direct your agent to review available safety policies, evaluate text for blocks or redactions, and examine simulation performance and reported issues.
  • Schedules and workflow monitoring: Instruct your agent to create, review, or delete scheduled agent runs, then inspect SuperFlow workflows and their execution status.
  • Voice activity review: Have your agent list available voice agents and review call transcripts by agent, session, organization, or date range.

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

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

Add Memory Messages

Store a batch of conversation messages in Lyzr Memory for an owner, session, and optional agent, with optional synchronous fact extraction.

Chat With Agent

Send a message or message history to an active Agent Studio agent and return its synchronous inference response for a session.

Clear Memory Session

Permanently clear messages and memories for one explicit owner and session in Lyzr Memory.

Create Agent

Create a single-task Agent Studio agent with an LLM provider, model, instructions, and optional tool configuration.

Create Agent Schedule

Create a cron schedule that runs one Agent Studio agent with a message in a specified timezone.

Delete Agent

Permanently delete one Agent Studio agent by ID.

Delete Agent Schedule

Permanently delete one agent cron schedule and remove its associated scheduler job.

Evaluate Text With RAI Policy

Apply one owned Responsible AI policy to text and return processed text, block decisions, warnings, detections, and redactions.

Get Agent

Return the current configuration and status of one Agent Studio agent by ID.

Get Knowledge Base

Return one Lyzr Knowledge Base configuration by its known RAG configuration ID.

Get Simulation Overview

Return aggregate Agent Simulation counts and average evaluation pass rate for the connected workspace.

List Agents

Return all Agent Studio agents owned by the connected API key, including IDs needed by lifecycle and inference tools.

List Agent Schedules

Return one page of agent cron schedules, optionally filtered by user, agent, or active state.

List Agent Simulation Issues

Return recent performance, error, and Responsible AI issues across monitored agents, optionally filtered by resolution and severity.

List RAI Policies

Return Responsible AI policies owned by the authenticated user, including policy IDs and enabled guardrail configuration.

List SuperFlow Executions

Return one page of SuperFlow execution records, optionally filtered by workflow and execution status.

List SuperFlow Workflows

Return all SuperFlow workflow definitions accessible to the connected API key, including workflow IDs and graph data.

List Voice Agents

Return saved Voice agents accessible to the connected organization, including IDs used to filter transcripts.

List Voice Transcripts

Return one page of accessible Voice call transcripts, optionally filtered by agent, session, organization, or date range.

Retrieve Knowledge

Retrieve relevant documents from a known Lyzr Knowledge Base using configurable basic, MMR, hypothetical-document, or time-aware retrieval.

Search Memories

Semantically search stored memories for one owner, within one session or across that owner's sessions, using Lyzr's hybrid vector and BM25 retrieval.

Set Agent Status

Activate or deactivate an Agent Studio agent.

FAQ

Frequently asked questions

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

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

Start with Lyzr.It takes 30 seconds.

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

Start building