How to integrate Diffbot MCP with OpenAI Agents SDK

This guide walks you through connecting Diffbot to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Diffbot agent that can extract specs and reviews from a product page, summarize key details from a news article url, list all bulk data extraction jobs for your account through natural language commands. This guide will help you understand how to give your OpenAI Agents SDK agent real control over a Diffbot account through Composio's Diffbot MCP server. Before we dive in, let's take a quick look at the key ideas and tools involved.

Diffbot logoDiffbot
Api Key

Diffbot is an AI-powered platform for extracting and structuring data from any web page. It transforms unstructured web content into rich, linked, and queryable data for analytics, research, and automation.

35 Tools

Introduction

This guide walks you through connecting Diffbot to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Diffbot agent that can extract specs and reviews from a product page, summarize key details from a news article url, list all bulk data extraction jobs for your account through natural language commands.

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

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

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

The Diffbot MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Diffbot account. It provides structured and secure access to web data extraction and analysis, so your agent can extract structured data from web pages, analyze content types, retrieve product details, manage bulk jobs, and search extracted datasets on your behalf.

  • Automatic content analysis and extraction: Let your agent analyze any web page and automatically extract structured data such as articles, products, events, images, or videos using AI-powered tools.
  • Article and discussion thread extraction: Effortlessly pull detailed metadata, authors, publication dates, and full discussion threads from news sites, blogs, forums, and comment sections.
  • Product and event data gathering: Instantly extract comprehensive product specifications, pricing, reviews, and event information including venues, dates, and descriptions from e-commerce or event pages.
  • Bulk job management and search: Enable your agent to list, monitor, and search across large-scale crawl or extraction jobs, making it easy to work with massive web data collections.
  • Account and usage insights: Retrieve your Diffbot account details, plan information, and usage statistics to stay on top of quotas and manage your web data operations efficiently.

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

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

Combine Entity Profiles

Combine multiple entity profiles into a unified view using the Diffbot Knowledge Graph.

Create Bulk Extract Job

Tool to submit a bulk extract job to process multiple URLs with Extract APIs.

Create or Update Custom API

Tool to create or update the parameters and ruleset of a Custom API.

Create Bulk Enhance Job

Tool to submit a bulk enhance job to enrich multiple entities asynchronously.

Delete Custom API

Tool to delete custom API definitions for a given URL pattern.

Delete KG Enhance Bulkjob

Tool to delete an Enhance Bulkjob.

Download Bulk Job Results

Tool to download results of a bulk enhance job with filtering options via POST request.

Enhance Entity with Knowledge Graph

Enrich a person or organization with comprehensive data from the Diffbot Knowledge Graph.

Diffbot Extract Job

Tool to extract structured job posting data from job listing pages.

Diffbot Extract List

Tool to extract structured data from list-style pages like news indexes, product listings, and directory pages.

Get Diffbot Account Details

Retrieves comprehensive Diffbot account information including subscription plan details, credit balance, usage history, and account status.

Diffbot Analyze

Automatically analyzes a web page to determine its type and extract structured data.

Get Article Data

Tool to extract information from articles, including authors, publication dates, and images.

Get Bulk Job Data

Tool to download extracted results from a completed bulk job.

Get Bulk Job Status

Tool to poll the status of a specific Diffbot Knowledge Graph Enhance bulk job.

Get Bulk Job Results

Tool to download the results of a completed Enhance Bulkjob.

Get Bulk Single Result

Tool to download the result of a single job within a Diffbot bulk enhance job.

Get Crawl Data

Download extracted results from a completed crawl job.

Get Discussion Thread

Extract structured discussion threads from web pages including forums, comment sections, product reviews, Reddit discussions, and blog comments.

Diffbot Get Event

Tool to extract event details from web pages.

Diffbot Get Image

Tool to extract detailed information about images, including dimensions and recognition data.

Get KG Coverage Report by ID

Download Knowledge Graph coverage report by report ID.

Diffbot Get Product

Tool to extract product information such as specifications, prices, availability, and reviews.

Get Video Data

Tool to extract information from videos, including titles, descriptions, and embedded HTML.

List Bulk Jobs

Tool to list all Bulk jobs associated with a specific token.

List Bulk Jobs Status For Token

Tool to get the status of all bulk enhance jobs for a token.

List Custom APIs

Tool to retrieve all Custom APIs and their extraction rules currently defined on your Diffbot token.

Manage Crawl Job

Manages Diffbot crawl jobs: pause, restart, delete, or view status.

Resolve Lost ID

Tool to resolve lost IDs in the Knowledge Graph.

Diffbot Knowledge Graph Search

Search the Diffbot Knowledge Graph using DQL (Diffbot Query Language).

Search Crawl Job Data

Tool to query crawl job collections using DQL (Diffbot Query Language).

Start Bulk Job

Tool to start a Bulk Extract job.

Start Crawl Job

Initiates a Diffbot crawl job that spiders a website starting from seed URLs and processes discovered pages with a specified Extract API.

Stop Bulk Job

Tool to pause (stop) a running Bulk job.

Stop KG Bulk Job By ID

Tool to stop an active Knowledge Graph Enhance bulk job by its ID.

FAQ

Frequently asked questions

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

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

Start with Diffbot.It takes 30 seconds.

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

Start building