How to integrate Kadoa MCP with OpenAI Agents SDK

Trusted by
AWS
Glean
Zoom
Airtable
GET STARTED FOR FREEGET A DEMO

30 min · no commitment · see it on your stack

Kadoa logo
OpenAI Agents SDK logo
divider

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

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.

Supported Tools & Triggers

Tools
Bulk Approve Validation RulesTool to bulk approve preview validation rules for a workflow.
Create Crawl ConfigTool to create a new crawling configuration in Kadoa.
Create Notification ChannelTool to create a notification channel for alerts delivery.
Create SchemaCreate a new data schema with specified fields and entity type.
Create Support IssueTool to create a support ticket in Kadoa.
Create Workflow TriggerTool to create a trigger that fires when a source workflow emits an event.
Delete All Validation RulesTool to soft-delete all validation rules for a specific workflow with optional audit trail.
Delete Crawl ConfigurationTool to delete a crawling configuration by its config ID.
Delete Notification ChannelTool to delete a notification channel by its ID.
Delete SchemaTool to delete a schema and all its revisions.
Delete Validation RuleTool to delete a validation rule from a Kadoa workflow.
Delete Validation Rules (Bulk)Tool to bulk delete multiple validation rules for a workflow.
Delete WorkflowDelete a workflow permanently from your Kadoa account.
Delete Workflow TriggerTool to delete a trigger from a Kadoa workflow.
Disable Validation RuleTool to disable a validation rule with a mandatory reason.
Enable Data ValidationTool to enable data validation on a specified workflow.
Execute Bulk Workflow OperationsExecute actions on multiple workflows at once.
Export Activity EventsTool to export activity events from audit logs to CSV format for compliance and audit purposes.
Export Activity WorkflowsTool to export workflow configurations and metadata as CSV for portfolio reviews and compliance reporting.
Get Workflow by IDRetrieve detailed configuration of a workflow by its ID.
Get all locationsRetrieves all available scraping proxy locations (countries) supported by Kadoa.
Get Crawl Bucket DataTool to retrieve file content from the Kadoa crawling bucket (HTML or screenshot).
Get Crawl ConfigurationTool to retrieve a crawling configuration by its ID.
Get Crawled Page ContentTool to retrieve content of a crawled page.
Get Crawled PagesTool to list pages crawled during a session.
Get Crawl StatusTool to fetch current status of a crawling session.
Get Event Type DetailsTool to retrieve details for a specific notification event type.
Get Notification Event TypesTool to retrieve supported notification event types.
Get Latest Workflow DataRetrieves the extracted data from a Kadoa workflow's most recent run (or a specific run if runId is provided).
Get Latest Workflow ValidationRetrieves the latest validation results for the most recent job of a workflow.
Get Notification ChannelTool to retrieve details of a specific notification channel.
Get Notification LogsTool to retrieve notification event logs with optional filtering by workflow, event type, and date range.
Get Notification SettingRetrieves a specific notification setting by its unique identifier.
Get Schema by IDRetrieve a specific schema by its unique identifier.
Get Validation AnomaliesTool to retrieve all anomalies for a specific validation.
Get Validation Anomalies By RuleTool to retrieve anomalies for a specific validation rule.
Get Validation ConfigurationTool to retrieve the data validation configuration for a specific workflow.
Get Validation RuleTool to retrieve a specific validation rule by its ID.
Get Workflow Audit LogRetrieve audit log entries for a workflow.
Get Workflow JobTool to retrieve the current status and telemetry information for a specific workflow job.
Get Workflow Run HistoryTool to fetch workflow run history.
Get WorkflowsRetrieve a paginated list of workflows with optional filtering.
Get Workflow TriggerTool to retrieve a specific trigger for a workflow.
Get Workflow Validation ResultsRetrieves the latest validation results for a specific workflow job.
Get Workspace DetailsTool to retrieve detailed information about a workspace (user, team, or organization).
List Activity EventsTool to retrieve activity events from audit logs with basic filtering and pagination.
List ChangesTool to retrieve all data changes detected across workflows in your Kadoa account.
List Crawl SessionsTool to retrieve a paginated list of crawling sessions with optional filtering.
List Job ValidationsTool to list all validation runs for a specific job with pagination support.
List Notification ChannelsTool to retrieve all notification channels configured for the account.
List Notification SettingsTool to retrieve all notification settings, with optional filtering by workflow ID or event type.
List SchemasTool to retrieve all schemas accessible by the authenticated user.
List Support StatesTool to retrieve available support issue states.
List Validation RulesTool to list all data validation rules with optional pagination and filtering.
List Workflow TriggersTool to get all triggers where the specified workflow is the source.
Pause Crawl SessionTool to pause an active crawling session.
Pause WorkflowTool to pause a running or scheduled workflow.
Create Advanced WorkflowTool to create an advanced workflow.
Start Crawl SessionStarts a new web crawling session to crawl and index pages from a website.
Create Notification SettingTool to create a notification setting linking channels to events.
Send Test NotificationSends a test notification event to verify notification channel configurations are working correctly.
Subscribe to Webhook EventsTool to subscribe to specified webhook events.
Create WorkflowCreate a new Kadoa web scraping workflow.
Configure Workflow MonitoringConfigure monitoring and scheduling for a Kadoa workflow to detect data changes.
Generate Workflow Validation RuleGenerate an AI-powered data validation rule for a Kadoa workflow.
Update Notification ChannelTool to update an existing notification channel.
Resume Crawl SessionTool to resume a paused crawling session.
Resume WorkflowResumes a paused, preview, or error workflow.
Run Ad-hoc ExtractionTool to synchronously extract data from a URL using a given template.
Run WorkflowTool to trigger a workflow to run immediately.
Schedule Validation JobTool to schedule a data validation job for a specific workflow job.
Unsubscribe from Webhook EventsUnsubscribe from webhook event notifications by deleting a notification setting.
Update Notification SettingsTool to update existing notification settings for events.
Update SchemaTool to update an existing Kadoa schema.
Update Validation ConfigurationTool to update the complete data validation configuration including alerting settings for a specific workflow.
Update Workflow MetadataTool to update workflow metadata such as name, description, tags, and configuration settings.
Update Workflow TriggerTool to update trigger properties including event type and enabled status.

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

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

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

Install dependencies

pip install composio_openai_agents openai-agents python-dotenv

Install the Composio SDK and the OpenAI Agents SDK.

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.

Import dependencies

import asyncio
import os
from dotenv import load_dotenv

from composio import Composio
from composio_openai_agents import OpenAIAgentsProvider
from agents import Agent, Runner, HostedMCPTool, SQLiteSession
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.

Set up the Composio instance

load_dotenv()

api_key = os.getenv("COMPOSIO_API_KEY")
user_id = os.getenv("USER_ID")

if not api_key:
    raise RuntimeError("COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key")

# Initialize Composio
composio = Composio(api_key=api_key, provider=OpenAIAgentsProvider())
What's happening:
  • load_dotenv() loads your .env file so OPENAI_API_KEY and COMPOSIO_API_KEY are available as environment variables.
  • Creating a Composio instance using the API Key and OpenAIAgentsProvider class.

Create a Tool Router session

# Create a Kadoa Tool Router session
session = composio.create(
    user_id=user_id,
    toolkits=["kadoa"]
)

mcp_url = 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.

Configure the agent

# Configure agent with MCP tool
agent = 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(
            tool_config={
                "type": "mcp",
                "server_label": "tool_router",
                "server_url": mcp_url,
                "headers": {"x-api-key": api_key},
                "require_approval": "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 dict includes the Composio API key for secure authentication with the MCP server.
  • require_approval: 'never' means the agent can execute Kadoa operations without asking for permission each time, making interactions smoother.

Start chat loop and handle conversation

print("\nComposio Tool Router session created.")

chat_session = SQLiteSession("conversation_openai_toolrouter")

print("\nChat started. Type your requests below.")
print("Commands: 'exit', 'quit', or 'q' to end\n")

async def main():
    try:
        result = await Runner.run(
            agent,
            "What can you help me with?",
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")
    except Exception as e:
        print(f"Error: {e}\n")

    while True:
        user_input = input("You: ").strip()
        if user_input.lower() in {"exit", "quit", "q"}:
            print("Goodbye!")
            break

        result = await Runner.run(
            agent,
            user_input,
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")

asyncio.run(main())
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 Runner.run().
  • The responses are printed to the console, and conversations are saved locally using SQLite.
  • 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 asyncio
import os
from dotenv import load_dotenv

from composio import Composio
from composio_openai_agents import OpenAIAgentsProvider
from agents import Agent, Runner, HostedMCPTool, SQLiteSession

load_dotenv()

api_key = os.getenv("COMPOSIO_API_KEY")
user_id = os.getenv("USER_ID")

if not api_key:
    raise RuntimeError("COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key")

# Initialize Composio
composio = Composio(api_key=api_key, provider=OpenAIAgentsProvider())

# Create Tool Router session
session = composio.create(
    user_id=user_id,
    toolkits=["kadoa"]
)
mcp_url = session.mcp.url

# Configure agent with MCP tool
agent = 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(
            tool_config={
                "type": "mcp",
                "server_label": "tool_router",
                "server_url": mcp_url,
                "headers": {"x-api-key": api_key},
                "require_approval": "never",
            }
        )
    ],
)

print("\nComposio Tool Router session created.")

chat_session = SQLiteSession("conversation_openai_toolrouter")

print("\nChat started. Type your requests below.")
print("Commands: 'exit', 'quit', or 'q' to end\n")

async def main():
    try:
        result = await Runner.run(
            agent,
            "What can you help me with?",
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")
    except Exception as e:
        print(f"Error: {e}\n")

    while True:
        user_input = input("You: ").strip()
        if user_input.lower() in {"exit", "quit", "q"}:
            print("Goodbye!")
            break

        result = await Runner.run(
            agent,
            user_input,
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")

asyncio.run(main())

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.

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

What are the differences in Tool Router MCP and Kadoa MCP?

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.

Can I use Tool Router MCP with OpenAI Agents SDK?

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.

Can I manage the permissions and scopes for Kadoa while using Tool Router?

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.

How safe is my data with Composio Tool Router?

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.

Used by agents from

Context
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai
Context
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai
Context
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai

Never worry about agent reliability

We handle tool reliability, observability, and security so you never have to second-guess an agent action.

Get started for freeGet a demo↗