How to integrate Kadoa MCP with OpenAI Agents SDK

This guide walks you through connecting Kadoa to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Kadoa agent that can fetch the latest data from your workflow, check crawl status for session abc123, list all pages crawled in last run through natural language commands. This guide will help you understand how to give your OpenAI Agents SDK agent real control over a Kadoa account through Composio's Kadoa 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
Kadoa logoKadoa
Api Key

Kadoa is an API-first platform for building and managing workflows that extract data from unstructured sources. It helps automate and monitor extraction tasks at scale.

77 Tools

Introduction

This guide walks you through connecting Kadoa to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Kadoa agent that can fetch the latest data from your workflow, check crawl status for session abc123, list all pages crawled in last run through natural language commands.

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

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

Also integrate Kadoa with

Claude Agent SDKClaude CodeClaude CoworkCodexOpenClawHermesCLIGoogle ADKLangChainVercel AI SDKMastra AILlamaIndexCrewAI

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

The Kadoa MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Kadoa account. It provides structured and secure access to your data extraction workflows, so your agent can launch crawls, monitor sessions, retrieve extracted data, and manage workflow configurations automatically on your behalf.

  • Automated workflow monitoring and management: Ask your agent to fetch workflow configurations, enable data validation, or get the latest results from any extraction workflow you have set up.
  • Crawling session control: Have your agent check the status of crawl sessions, list all crawled pages, and pull the raw content (HTML or Markdown) from any page processed by a workflow.
  • Notification channel setup and retrieval: Direct your agent to create notification channels, list available notification event types, and fetch specific channel configurations for streamlined alerting.
  • Location and environment awareness: Let your agent retrieve all supported locations to ensure workflows run in the right environment before launching new extraction jobs.
  • Seamless data access: Instruct your agent to quickly get the most recent data output from any workflow, keeping your automations and dashboards always up to date.

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

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

Bulk Approve Validation Rules

Tool to bulk approve preview validation rules for a workflow.

Create Crawl Config

Tool to create a new crawling configuration in Kadoa.

Create Notification Channel

Tool to create a notification channel for alerts delivery.

Create Schema

Create a new data schema with specified fields and entity type.

Create Support Issue

Tool to create a support ticket in Kadoa.

Create Workflow Trigger

Tool to create a trigger that fires when a source workflow emits an event.

Delete All Validation Rules

Tool to soft-delete all validation rules for a specific workflow with optional audit trail.

Delete Crawl Configuration

Tool to delete a crawling configuration by its config ID.

Delete Notification Channel

Tool to delete a notification channel by its ID.

Delete Schema

Tool to delete a schema and all its revisions.

Delete Validation Rule

Tool to delete a validation rule from a Kadoa workflow.

Delete Validation Rules (Bulk)

Tool to bulk delete multiple validation rules for a workflow.

Delete Workflow

Delete a workflow permanently from your Kadoa account.

Delete Workflow Trigger

Tool to delete a trigger from a Kadoa workflow.

Disable Validation Rule

Tool to disable a validation rule with a mandatory reason.

Enable Data Validation

Tool to enable data validation on a specified workflow.

Execute Bulk Workflow Operations

Execute actions on multiple workflows at once.

Export Activity Events

Tool to export activity events from audit logs to CSV format for compliance and audit purposes.

Export Activity Workflows

Tool to export workflow configurations and metadata as CSV for portfolio reviews and compliance reporting.

Get Workflow by ID

Retrieve detailed configuration of a workflow by its ID.

Get all locations

Retrieves all available scraping proxy locations (countries) supported by Kadoa.

Get Crawl Bucket Data

Tool to retrieve file content from the Kadoa crawling bucket (HTML or screenshot).

Get Crawl Configuration

Tool to retrieve a crawling configuration by its ID.

Get Crawled Page Content

Tool to retrieve content of a crawled page.

Get Crawled Pages

Tool to list pages crawled during a session.

Get Crawl Status

Tool to fetch current status of a crawling session.

Get Event Type Details

Tool to retrieve details for a specific notification event type.

Get Notification Event Types

Tool to retrieve supported notification event types.

Get Latest Workflow Data

Retrieves the extracted data from a Kadoa workflow's most recent run (or a specific run if runId is provided).

Get Latest Workflow Validation

Retrieves the latest validation results for the most recent job of a workflow.

Get Notification Channel

Tool to retrieve details of a specific notification channel.

Get Notification Logs

Tool to retrieve notification event logs with optional filtering by workflow, event type, and date range.

Get Notification Setting

Retrieves a specific notification setting by its unique identifier.

Get Schema by ID

Retrieve a specific schema by its unique identifier.

Get Validation Anomalies

Tool to retrieve all anomalies for a specific validation.

Get Validation Anomalies By Rule

Tool to retrieve anomalies for a specific validation rule.

Get Validation Configuration

Tool to retrieve the data validation configuration for a specific workflow.

Get Validation Rule

Tool to retrieve a specific validation rule by its ID.

Get Workflow Audit Log

Retrieve audit log entries for a workflow.

Get Workflow Job

Tool to retrieve the current status and telemetry information for a specific workflow job.

Get Workflow Run History

Tool to fetch workflow run history.

Get Workflows

Retrieve a paginated list of workflows with optional filtering.

Get Workflow Trigger

Tool to retrieve a specific trigger for a workflow.

Get Workflow Validation Results

Retrieves the latest validation results for a specific workflow job.

Get Workspace Details

Tool to retrieve detailed information about a workspace (user, team, or organization).

List Activity Events

Tool to retrieve activity events from audit logs with basic filtering and pagination.

List Changes

Tool to retrieve all data changes detected across workflows in your Kadoa account.

List Crawl Sessions

Tool to retrieve a paginated list of crawling sessions with optional filtering.

List Job Validations

Tool to list all validation runs for a specific job with pagination support.

List Notification Channels

Tool to retrieve all notification channels configured for the account.

List Notification Settings

Tool to retrieve all notification settings, with optional filtering by workflow ID or event type.

List Schemas

Tool to retrieve all schemas accessible by the authenticated user.

List Support States

Tool to retrieve available support issue states.

List Validation Rules

Tool to list all data validation rules with optional pagination and filtering.

List Workflow Triggers

Tool to get all triggers where the specified workflow is the source.

Pause Crawl Session

Tool to pause an active crawling session.

Pause Workflow

Tool to pause a running or scheduled workflow.

Create Advanced Workflow

Tool to create an advanced workflow.

Start Crawl Session

Starts a new web crawling session to crawl and index pages from a website.

Create Notification Setting

Tool to create a notification setting linking channels to events.

Send Test Notification

Sends a test notification event to verify notification channel configurations are working correctly.

Subscribe to Webhook Events

Tool to subscribe to specified webhook events.

Create Workflow

Create a new Kadoa web scraping workflow.

Configure Workflow Monitoring

Configure monitoring and scheduling for a Kadoa workflow to detect data changes.

Generate Workflow Validation Rule

Generate an AI-powered data validation rule for a Kadoa workflow.

Update Notification Channel

Tool to update an existing notification channel.

Resume Crawl Session

Tool to resume a paused crawling session.

Resume Workflow

Resumes a paused, preview, or error workflow.

Run Ad-hoc Extraction

Tool to synchronously extract data from a URL using a given template.

Run Workflow

Tool to trigger a workflow to run immediately.

Schedule Validation Job

Tool to schedule a data validation job for a specific workflow job.

Unsubscribe from Webhook Events

Unsubscribe from webhook event notifications by deleting a notification setting.

Update Notification Settings

Tool to update existing notification settings for events.

Update Schema

Tool to update an existing Kadoa schema.

Update Validation Configuration

Tool to update the complete data validation configuration including alerting settings for a specific workflow.

Update Workflow Metadata

Tool to update workflow metadata such as name, description, tags, and configuration settings.

Update Workflow Trigger

Tool to update trigger properties including event type and enabled status.

FRAMEWORKS

How to build Kadoa MCP Agent with another framework

Claude Agent SDK logo

Claude Agent SDK

Use Kadoa MCP with Claude Agent SDK

Claude Code logo

Claude Code

Use Kadoa MCP with Claude Code

Claude Cowork logo

Claude Cowork

Use Kadoa MCP with Claude Cowork

Codex logo

Codex

Use Kadoa MCP with Codex

OpenClaw logo

OpenClaw

Use Kadoa MCP with OpenClaw

Hermes logo

Hermes

Use Kadoa MCP with Hermes

CLI logo

CLI

Use Kadoa MCP with CLI

Google ADK logo

Google ADK

Use Kadoa MCP with Google ADK

LangChain logo

LangChain

Use Kadoa MCP with LangChain

Vercel AI SDK logo

Vercel AI SDK

Use Kadoa MCP with Vercel AI SDK

Mastra AI logo

Mastra AI

Use Kadoa MCP with Mastra AI

LlamaIndex logo

LlamaIndex

Use Kadoa MCP with LlamaIndex

CrewAI logo

CrewAI

Use Kadoa MCP with CrewAI

FAQ

Frequently asked questions

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

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

Start with Kadoa.It takes 30 seconds.

Managed auth, hosted MCP servers, and every Kadoa 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