How to integrate Cardly MCP with OpenAI Agents SDK

This guide walks you through connecting Cardly to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Cardly agent that can create a new contact list named 'vip clients', list all available artwork for our next campaign, generate a preview of a card using latest artwork through natural language commands. This guide will help you understand how to give your OpenAI Agents SDK agent real control over a Cardly account through Composio's Cardly MCP server. Before we dive in, let's take a quick look at the key ideas and tools involved.

Cardly logoCardly
Api Key

Cardly is a platform for creating and sending personalized direct mail to customers. It helps businesses break through the digital clutter by getting real engagement via physical mailboxes.

29 Tools

Introduction

This guide walks you through connecting Cardly to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Cardly agent that can create a new contact list named 'vip clients', list all available artwork for our next campaign, generate a preview of a card using latest artwork through natural language commands.

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

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

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

The Cardly MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Cardly account. It provides structured and secure access to your Cardly workspace, so your agent can create contact lists, generate card previews, manage invitations, and access artwork or credit history for seamless customer engagement tasks.

  • Automated contact list creation and management: Easily instruct your agent to set up new contact lists or manage existing ones, streamlining outreach campaigns and personalized mailings.
  • Card preview generation and artwork browsing: Let your agent generate watermarked card previews and browse available artwork to help you select the right designs before sending mailers.
  • Real-time credit and gift history access: Ask your agent to fetch your credit or gift credit history so you always know your account status and can track usage or plan new campaigns.
  • Invitation and webhook management: Direct your agent to handle invitations—listing, deleting, or auditing user invites—or manage webhooks for seamless integration with other systems.
  • Font and design asset exploration: Have your agent list available fonts and artwork, making it easier to choose creative assets for your next customer engagement initiative.

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

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

Create Contact List

Tool to add a new contact list.

Create Invitation

Tool to send an invitation to use your organisation portal.

Create Webhook

Tool to create a new webhook subscription.

Delete Invitation

Tool to delete an invitation by unique ID, immediately invalidating it for acceptance.

Delete Invitation by Email

Deletes a pending invitation by email address, immediately invalidating it and preventing acceptance.

Delete User

Tool to delete a user by unique ID, immediately revoking their access to your organisation portal.

Delete User by Email

Deletes a user by email address, immediately revoking their access to your organisation portal.

Delete Webhook

Tool to delete a webhook.

Echo Request

Tool to echo all request parameters, body, and headers for debugging purposes.

Generate Preview

Tool to generate a low-quality, watermarked preview document for a card.

Get Artwork

Tool to retrieve information on a specific piece of artwork by its unique ID.

Get Webhook

Tool to get details on an existing webhook.

List Artwork

Tool to retrieve the currently available artwork for your organisation.

List Contact Lists

Tool to retrieve all active contact lists for your organization.

List Credit History

Retrieves the account's credit transaction history showing all credits and debits.

List Doodles

Retrieve your currently available doodles from Cardly.

List Fonts

List available fonts for handwriting and text personalization in Cardly cards.

List Gift Credit History

Lists gift credit history records for your organization with pagination and optional time-based filtering.

List Invitations

Tool to retrieve active invitations for your organisation with optional filters.

List Media

Tool to retrieve the currently available media sizes for product artwork.

List Orders

Retrieves a paginated list of orders placed by your organization.

List Templates

Tool to retrieve your currently available templates from Cardly.

List Users

Tool to retrieve all users associated with your account.

List Webhooks

Retrieves all webhooks configured for your organization, including their status, target URLs, subscribed events, and delivery statistics.

List Writing Styles

Tool to list available writing styles.

Retrieve Account Balance

Tool to retrieve the current account and gift credit balances for your organisation.

Retrieve Order

Retrieves detailed information about a specific order by its ID.

Retrieve User

Retrieves detailed information about a specific user account by ID.

Update Webhook

Tool to update a webhook’s settings, including target URL and events.

FAQ

Frequently asked questions

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

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

Start with Cardly.It takes 30 seconds.

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

Start building