SIGN UPLOG IN
X (Twitter)LinkedInGitHubDiscordYouTube

How to integrate Heyzine MCP with Claude Agent SDK

Connect Claude Agent SDK to Heyzine MCP. Convert this pdf to a flipbook instantly, get embed code for your latest flipbook, and more using natural language, with authentication handled for you.

Get started for freeGet a demo
Heyzine logoHeyzine
Api Key

Heyzine is a flipbook maker that turns static PDFs into interactive, customizable digital publications with page flip effects. It's perfect for engaging audiences with visually rich, professional digital magazines and catalogs.

14 Tools

Introduction

This guide walks you through connecting Heyzine to the Claude Agent SDK using the Composio tool router. By the end, you'll have a working Heyzine agent that can convert PDFs into flipbooks, list and delete flipbooks, password protect flipbooks, update social metadata, and check your API limits through natural language commands.

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

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

Also integrate Heyzine with

Claude CodeClaude CoworkOpenAI Agents SDKGrok BotCodexOpenClawHermesAtomic AgentGoogle ADKLangChainVercel AI SDKMastra AILlamaIndexCrewAIPydantic AIAutoGen

TL;DR

Here's what you'll learn:
  • Get and set up your Claude/Anthropic and Composio API keys
  • Install the necessary dependencies
  • Initialize Composio and create a Tool Router session for Heyzine
  • Configure an AI agent that can use Heyzine as a tool
  • Run a live chat session where you can ask the agent to perform Heyzine operations

What is Claude Agent SDK?

The Claude Agent SDK is Anthropic's official framework for building AI agents powered by Claude. It provides a streamlined interface for creating agents with MCP tool support and conversation management.

Key features include:

  • Native MCP Support: Built-in support for Model Context Protocol servers
  • Permission Modes: Control tool execution permissions
  • Streaming Responses: Real-time response streaming for interactive applications
  • Context Manager: Clean async context management for sessions

What is the Heyzine MCP server, and what's possible with it?

The Heyzine MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Heyzine account. It provides structured and secure access to your digital publishing tools, so your agent can create flipbooks, manage existing publications, retrieve embed codes, and automate PDF-to-flipbook conversions on your behalf.

  • Instant flipbook creation: Quickly convert PDFs, DOCX, or PPTX files into interactive flipbooks with a single prompt.
  • Automated flipbook management: Effortlessly list, retrieve, or delete existing flipbooks from your Heyzine account without manual work.
  • Seamless website integration: Instantly fetch HTML or iframe embed codes for any flipbook, making it easy to add rich publications to your site.
  • Social sharing optimization: Retrieve and refine social metadata for your flipbooks, like title, description, and thumbnails, to boost engagement.
  • API usage monitoring: Let your agent check API rate limits and monitor usage to ensure smooth, uninterrupted publishing workflows.

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 Claude/Anthropic API Key
  • Primary know-how of Claude Agents SDK
  • A Heyzine account
  • Some knowledge of Python
2

Getting API Keys for Claude/Anthropic and Composio

Claude/Anthropic API Key
  • Go to the Anthropic Console and create an API key. You'll need credits to use the models.
  • Keep the API key safe.
Composio API Key
  • Log in to the Composio dashboard.
  • Navigate to your API settings and generate a new API key.
  • Store this key securely as you'll need it for authentication.
3

Install dependencies

npm install @anthropic-ai/claude-agent-sdk @composio/core dotenv

Install the Composio SDK and the Claude Agents SDK.

What's happening:

  • @composio/core provides Composio integration for Anthropic
  • @anthropic-ai/claude-agent-sdk is the core agent framework
  • dotenv/config loads environment variables
4

Set up environment variables

bash
COMPOSIO_API_KEY=your_composio_api_key_here
USER_ID=your_user_id_here
ANTHROPIC_API_KEY=your_anthropic_api_key_here

Create a .env file in your project root.

What's happening:

  • COMPOSIO_API_KEY authenticates with Composio
  • USER_ID identifies the user for session management
  • ANTHROPIC_API_KEY authenticates with Anthropic/Claude
5

Import dependencies

import 'dotenv/config';
import readline from 'node:readline';
import { Composio } from '@composio/core';
import { query, type Options } from "@anthropic-ai/claude-agent-sdk";

dotenv.config();
What's happening:
  • We're importing all necessary libraries including the Claude Agent SDK and Composio
  • The dotenv.config() function loads environment variables from your .env file
  • This setup prepares the foundation for connecting Claude with Heyzine functionality
6

Create a Composio instance and Tool Router session

async function chat() {
  const { COMPOSIO_API_KEY, USER_ID } = process.env;
  if (!COMPOSIO_API_KEY || !USER_ID) {
    throw new Error('COMPOSIO_API_KEY and USER_ID required in .env');
  }

  const composio = new Composio({ apiKey: COMPOSIO_API_KEY });

  // Create Tool Router session for Heyzine
  const session = await composio.create(USER_ID, {
    toolkits: ['heyzine'],
  });
  const mcpUrl = session?.mcp.url;
What's happening:
  • The function checks for the required COMPOSIO_API_KEY environment variable
  • We're creating a Composio instance using our API key
  • The create method creates a Tool Router session for Heyzine
  • The returned url is the MCP server URL that your agent will use
7

Configure Claude Agent with MCP

const options: Options = {
  permissionMode: 'bypassPermissions',
  mcpServers: {
    composio: {
      type: 'http',
      url: mcpUrl,
      headers: { 'x-api-key': COMPOSIO_API_KEY }
    }
  },
  systemPrompt: 'You are a helpful assistant with access to Heyzine tools via Composio.',
  maxTurns: 10,
};
What's happening:
  • We're configuring the Claude Agent options with the MCP server URL
  • permissionMode: 'bypassPermissions' allows the agent to execute operations without asking for permission each time
  • The system prompt instructs the agent that it has access to Heyzine
  • maxTurns: 10 limits the conversation length to prevent excessive API usage
8

Create client and start chat loop

const rl = readline.createInterface({
    input: process.stdin,
    output: process.stdout,
    prompt: 'You: '
  });

  console.log('\nChat started. Type "exit" to quit.\n');

  let isProcessing = false;

  async function ask(prompt: string) {
    isProcessing = true;
    rl.pause();

    process.stdout.write('Claude is thinking...');
    const stream = query({ prompt, options });

    let firstChunk = true;
    for await (const msg of stream) {
      const content = (msg as any).message?.content || (msg as any).content;
      if (Array.isArray(content)) {
        for (const block of content) {
          if (block.type === 'text' && block.text) {
            if (firstChunk) {
              process.stdout.write('\r\x1b[K');
              process.stdout.write('Claude: ');
              firstChunk = false;
            }
            process.stdout.write(block.text);
          }
        }
      }
    }
    process.stdout.write('\n\n');

    isProcessing = false;
    rl.resume();
    rl.prompt();
  }

  rl.on('line', async (line) => {
    if (isProcessing) return;

    const input = line.trim();
    if (input === 'exit') {
      rl.close();
      process.exit(0);
    }
    if (input) await ask(input);
    else rl.prompt();
  });

  await ask('What can you help me with?');
}
What's happening:
  • The readline interface is created to handle user input and output
  • The query function is used to send the user's input to the agent
  • The chat loop continues until the user types 'exit' or 'quit'
9

Run the application

try {
  await chat();
} catch (error) {
  console.error(error);
  process.exit(1);
}
What's happening:
  • The chat function is the entry point for the application
  • The try-catch block is used to handle any errors that occur

Complete Code

Here's the complete code to get you started with Heyzine and Claude Agent SDK:

import 'dotenv/config';
import readline from 'node:readline';
import { Composio } from '@composio/core';
import { query, type Options } from "@anthropic-ai/claude-agent-sdk";

async function chat() {
  const { COMPOSIO_API_KEY, USER_ID } = process.env;
  if (!COMPOSIO_API_KEY || !USER_ID) {
    throw new Error('COMPOSIO_API_KEY and USER_ID required in .env');
  }

  const composio = new Composio({ apiKey: COMPOSIO_API_KEY });
  const session = await composio.create(USER_ID, {
    toolkits: ['heyzine']
  });
  const mcp_url = session?.mcp.url;

  const options: Options = {
    permissionMode: 'bypassPermissions',
    mcpServers: {
      composio: {
        type: 'http',
        url: mcp_url,
        headers: { 'x-api-key': COMPOSIO_API_KEY }
      }
    },
    systemPrompt: 'You are a helpful assistant with access to Heyzine tools via Composio.',
    maxTurns: 10,
  };

  const rl = readline.createInterface({
    input: process.stdin,
    output: process.stdout,
    prompt: 'You: '
  });

  console.log('\nChat started. Type "exit" to quit.\n');

  let isProcessing = false;

  async function ask(prompt: string) {
    isProcessing = true;
    rl.pause();

    process.stdout.write('Claude is thinking...');
    const stream = query({ prompt, options });

    let firstChunk = true;
    for await (const msg of stream) {
      const content = (msg as any).message?.content || (msg as any).content;
      if (Array.isArray(content)) {
        for (const block of content) {
          if (block.type === 'text' && block.text) {
            if (firstChunk) {
              process.stdout.write('\r\x1b[K');
              process.stdout.write('Claude: ');
              firstChunk = false;
            }
            process.stdout.write(block.text);
          }
        }
      }
    }
    process.stdout.write('\n\n');

    isProcessing = false;
    rl.resume();
    rl.prompt();
  }

  rl.on('line', async (line) => {
    if (isProcessing) return;

    const input = line.trim();
    if (input === 'exit') {
      rl.close();
      process.exit(0);
    }
    if (input) await ask(input);
    else rl.prompt();
  });

  await ask('What can you help me with?');
}

try {
  await chat();
} catch (error) {
  console.error(error);
  process.exit(1);
}

Conclusion

You've successfully built a Claude Agent SDK agent that can interact with Heyzine through Composio's Tool Router.

Key features:

  • Native MCP support through Claude's agent framework
  • Streaming responses for real-time interaction
  • Permission bypass for smooth automated workflows
You can extend this by adding more toolkits, implementing custom business logic, or building a web interface around the agent.
TOOLS

Supported Tools

Every Heyzine action and event your agent gets out of the box.

Create Flipbook Link

Tool to create a direct flipbook link.

Create Flipbook Asynchronously

Start an asynchronous flipbook conversion from a document URL and return the conversion state and flipbook details supplied in the response.

Create Flipbook Sync

Tool to convert a PDF, DOCX, or PPTX into a flipbook synchronously via REST API.

Delete Flipbook

Tool to delete a flipbook.

Get API Limits

Probe a flipbook-list response for rate-limit headers and return any matching headers, the HTTP status and request ID.

Get Flipbook ID Tool

Tool to retrieve HTML for Flipbook ID tool.

Get Flipbook List

Retrieve a list of flipbooks for the authenticated account, with optional page, limit, search and tag parameters when supported by the API.

Get Flipbook Social Metadata

Retrieve a flipbook's title and thumbnail from an oEmbed response.

Get jQuery Plugin

Tool to retrieve the Heyzine jQuery plugin script URL and usage snippet.

Setup Heyzine Webhooks

Helper tool to validate prerequisites for Heyzine webhooks.

Update Flipbook Access List

Add access entries to a flipbook individually and return an aggregate result.

Update Flipbook Password Protection

Tool to update flipbook password protection settings.

Update Flipbook Social Metadata

Tool to update a flipbook's social metadata.

Heyzine Webhooks - Leads

Validate a supplied Heyzine leads webhook payload and return a success acknowledgement with its webhook ID.

FRAMEWORKS

How to build Heyzine MCP Agent with another framework

Claude Code logo

Claude Code

Use Heyzine MCP with Claude Code

Claude Cowork logo

Claude Cowork

Use Heyzine MCP with Claude Cowork

OpenAI Agents SDK logo

OpenAI Agents SDK

Use Heyzine MCP with OpenAI Agents SDK

Grok Bot logo

Grok Bot

Use Heyzine MCP with Grok Bot

Codex logo

Codex

Use Heyzine MCP with Codex

OpenClaw logo

OpenClaw

Use Heyzine MCP with OpenClaw

Hermes logo

Hermes

Use Heyzine MCP with Hermes

Atomic Agent logo

Atomic Agent

Use Heyzine MCP with Atomic Agent

Google ADK logo

Google ADK

Use Heyzine MCP with Google ADK

LangChain logo

LangChain

Use Heyzine MCP with LangChain

Vercel AI SDK logo

Vercel AI SDK

Use Heyzine MCP with Vercel AI SDK

Mastra AI logo

Mastra AI

Use Heyzine MCP with Mastra AI

LlamaIndex logo

LlamaIndex

Use Heyzine MCP with LlamaIndex

CrewAI logo

CrewAI

Use Heyzine MCP with CrewAI

Pydantic AI logo

Pydantic AI

Use Heyzine MCP with Pydantic AI

AutoGen logo

AutoGen

Use Heyzine MCP with AutoGen

FAQ

Frequently asked questions

With a standalone Heyzine MCP server, the agents and LLMs can only access a fixed set of Heyzine tools tied to that server. However, with the Composio Tool Router, agents can dynamically load tools from Heyzine and many other apps based on the task at hand, all through a single MCP endpoint.

Yes, you can. Claude Agent 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 Heyzine tools.

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

Start with Heyzine.It takes 30 seconds.

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

Start building