How to integrate Tapfiliate MCP with OpenAI Agents SDK

This guide walks you through connecting Tapfiliate to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Tapfiliate agent that can list all active affiliates for this month, retrieve payout methods for affiliate jane doe, create a payment for affiliate id 12345 through natural language commands. This guide will help you understand how to give your OpenAI Agents SDK agent real control over a Tapfiliate account through Composio's Tapfiliate MCP server. Before we dive in, let's take a quick look at the key ideas and tools involved.

Tapfiliate logoTapfiliate
Api Key

Tapfiliate is an affiliate and referral tracking platform for businesses. It helps companies efficiently manage, track, and grow their affiliate programs.

40 Tools

Introduction

This guide walks you through connecting Tapfiliate to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Tapfiliate agent that can list all active affiliates for this month, retrieve payout methods for affiliate jane doe, create a payment for affiliate id 12345 through natural language commands.

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

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

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

The Tapfiliate MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Tapfiliate account. It provides structured and secure access to your affiliate and referral program data, so your agent can perform actions like managing affiliates, tracking commissions, handling payments, and organizing programs on your behalf.

  • Affiliate management and insights: Instantly list all affiliates, retrieve detailed affiliate profiles, or remove affiliates as your programs evolve.
  • Commission tracking and reporting: Let your agent fetch comprehensive commission records, apply filters, and access historical payouts for monitoring performance.
  • Automated payment handling: Effortlessly list, retrieve, or create payments to credit affiliates, ensuring accurate and timely compensation.
  • Payout method discovery: Retrieve available payout options for affiliates to streamline compensation workflows and support diverse payment needs.
  • Program organization and overview: Quickly list all affiliate programs and assets, helping you stay on top of your marketing initiatives and campaign structure.

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

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

Retrieve an Affiliate

Tool to retrieve details of a specific affiliate.

Cancel a Payment

Tool to cancel a specific payment.

List all commissions

Tool to retrieve all commissions.

Create an Affiliate

Tool to create a new affiliate account.

Create Affiliate Group

Tool to create a new affiliate group.

Create Affiliate Note

Tool to create a note for an affiliate.

Create Affiliate Prospect

Tool to create an affiliate prospect.

Delete affiliate meta data

Tool to delete metadata by key for an affiliate.

Delete an affiliate prospect

Tool to delete a specific affiliate prospect.

Delete an affiliate

Tool to delete a specific affiliate.

Get Affiliate Balances

Tool to retrieve an affiliate's balances across multiple currencies.

Get Affiliate Meta Data by Key

Tool to retrieve specific metadata value by key for an affiliate.

Get Affiliate Prospect

Tool to retrieve details of a specific affiliate prospect.

Retrieve a Program

Tool to retrieve details of a specific program.

List affiliate custom fields

Tool to get custom fields configured for affiliates.

List all affiliate groups

Tool to list all affiliate groups.

List Affiliate Meta Data

Tool to retrieve metadata for a specific affiliate.

List affiliate notes

Tool to list notes for a specific affiliate.

List affiliate's payments

Tool to list all payments for a specific affiliate.

List Affiliate Programs

Tool to list all programs (affiliations) associated with a specific affiliate.

List Affiliate Prospects

Tool to list all affiliate prospects.

List all affiliates

Tool to list all affiliates.

List all balances

Tool to list all outstanding affiliate balances.

List conversions

Tool to list all conversions.

List all customers

Tool to list all customers with optional filtering by program, customer ID, affiliate, or date range.

List program affiliates

Tool to list all affiliates in a specific program.

List program bonuses

Tool to list all bonuses for a specific program.

List program commission types

Tool to list commission types for a specific program.

List program MLM levels

Tool to list MLM levels for a program.

Create a Payment

Tool to create a payment.

List all payments

Tool to list all payments.

Retrieve a Payment

Tool to retrieve details of a specific payment.

List all payout methods

Tool to retrieve a list of all payout methods for an affiliate.

List all programs

Tool to list all programs.

Remove affiliate group from affiliate

Tool to remove affiliate group from an affiliate.

Set Affiliate Group

Tool to set the affiliate group for a specific affiliate.

Set Affiliate Meta Data

Tool to update (replace) metadata for an affiliate.

Set Affiliate Metadata by Key

Tool to set or update a specific metadata field for an affiliate by key.

Set Affiliate Parent

Tool to set a parent affiliate relationship for a child affiliate.

Update Affiliate Group

Tool to update an affiliate group's details.

FAQ

Frequently asked questions

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

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

Start with Tapfiliate.It takes 30 seconds.

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

Start building