SIGN UPLOG IN
X (Twitter)LinkedInGitHubDiscordYouTube

How to integrate Heyzine MCP with LangChain

Connect LangChain 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 LangChain 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 LangChain 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 SDKClaude Agent SDKGrok BotCodexOpenClawHermesAtomic AgentGoogle ADKVercel AI SDKMastra AILlamaIndexCrewAIPydantic AIAutoGen

TL;DR

Here's what you'll learn:
  • Get and set up your OpenAI and Composio API keys
  • Connect your Heyzine project to Composio
  • Create a Tool Router MCP session for Heyzine
  • Initialize an MCP client and retrieve Heyzine tools
  • Build a LangChain agent that can interact with Heyzine
  • Set up an interactive chat interface for testing

What is LangChain?

LangChain is a framework for developing applications powered by language models. It provides tools and abstractions for building agents that can reason, use tools, and maintain conversation context.

Key features include:

  • Agent Framework: Build agents that can use tools and make decisions
  • MCP Integration: Connect to external services through Model Context Protocol adapters
  • Memory Management: Maintain conversation history across interactions
  • Multi-Provider Support: Works with OpenAI, Anthropic, and other LLM providers

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 step10 STEPS
1

Prerequisites

Before starting this tutorial, make sure you have:
  • Python 3.10 or higher installed on your system
  • A Composio account with an API key
  • An OpenAI API key
  • Basic familiarity with Python and async programming
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
  • 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 @composio/langchain @langchain/core @langchain/openai @langchain/mcp-adapters dotenv

Install the required packages for LangChain with MCP support.

What's happening:

  • @composio/langchain provides Composio integration for LangChain
  • @langchain/mcp-adapters enables MCP client connections
  • @langchain/core is the core agent framework
  • dotenv/config loads environment variables
4

Set up environment variables

bash
COMPOSIO_API_KEY=your_composio_api_key_here
COMPOSIO_USER_ID=your_composio_user_id_here
OPENAI_API_KEY=your_openai_api_key_here

Create a .env file in your project root.

What's happening:

  • COMPOSIO_API_KEY authenticates your requests to Composio's API
  • COMPOSIO_USER_ID identifies the user for session management
  • OPENAI_API_KEY enables access to OpenAI's language models
5

Import dependencies

import { Composio } from '@composio/core';
import { LangchainProvider } from '@composio/langchain';
import { MultiServerMCPClient } from "@langchain/mcp-adapters";
import { createAgent } from "langchain";
import * as readline from 'readline';
import 'dotenv/config';

dotenv.config();
What's happening:
  • We're importing LangChain's MCP adapter and Composio SDK
  • The dotenv/config import loads environment variables from your .env file
  • This setup prepares the foundation for connecting LangChain with Heyzine functionality through MCP
6

Initialize Composio client

const composioApiKey = process.env.COMPOSIO_API_KEY;
const userId = process.env.COMPOSIO_USER_ID;

if (!composioApiKey) throw new Error('COMPOSIO_API_KEY is not set');
if (!userId) throw new Error('COMPOSIO_USER_ID is not set');

async function main() {
    const composio = new Composio({
        apiKey: composioApiKey as string,
        provider: new LangchainProvider()
    });
What's happening:
  • We're loading the COMPOSIO_API_KEY from environment variables and validating it exists
  • Creating a Composio instance that will manage our connection to Heyzine tools
  • Validating that COMPOSIO_USER_ID is also set before proceeding
7

Create a Tool Router session

const session = await composio.create(
    userId as string,
    {
        toolkits: ['heyzine']
    }
);

const url = session.mcp.url;
What's happening:
  • We're creating a Tool Router session that gives your agent access to Heyzine tools
  • The create method takes the user ID and specifies which toolkits should be available
  • The returned session.mcp.url is the MCP server URL that your agent will use
  • This approach allows the agent to dynamically load and use Heyzine tools as needed
8

Configure the agent with the MCP URL

const client = new MultiServerMCPClient({
    "heyzine-agent": {
        transport: "http",
        url: url,
        headers: {
            "x-api-key": process.env.COMPOSIO_API_KEY
        }
    }
});

const tools = await client.getTools();

const agent = createAgent({ model: "gpt-5", tools });
What's happening:
  • We're creating a MultiServerMCPClient that connects to our Heyzine MCP server via HTTP
  • The client is configured with a name and the URL from our Tool Router session
  • getTools() retrieves all available Heyzine tools that the agent can use
  • We're creating a LangChain agent using the GPT-5 model
9

Set up interactive chat interface

let conversationHistory: any[] = [];

console.log("Chat started! Type 'exit' or 'quit' to end the conversation.\n");
console.log("Ask any Heyzine related question or task to the agent.\n");

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

rl.prompt();

rl.on('line', async (userInput: string) => {
    const trimmedInput = userInput.trim();

    if (['exit', 'quit', 'bye'].includes(trimmedInput.toLowerCase())) {
        console.log("\nGoodbye!");
        rl.close();
        process.exit(0);
    }

    if (!trimmedInput) {
        rl.prompt();
        return;
    }

    conversationHistory.push({ role: "user", content: trimmedInput });
    console.log("\nAgent is thinking...\n");

    const response = await agent.invoke({ messages: conversationHistory });
    conversationHistory = response.messages;

    const finalResponse = response.messages[response.messages.length - 1]?.content;
    console.log(`Agent: ${finalResponse}\n`);
        
        rl.prompt();
    });

    rl.on('close', () => {
        console.log('\n👋 Session ended.');
        process.exit(0);
    });
What's happening:
  • We initialize an empty conversationHistory list to maintain context across interactions
  • A readline interface is used to continuously accept user input from the command line
  • When a user types a message, it's added to the conversation history and sent to the agent
  • The agent processes the request using the invoke() method with the full conversation history
  • Users can type 'exit', 'quit', or 'bye' to end the chat session gracefully
10

Run the application

main().catch((err) => {
    console.error('Fatal error:', err);
    process.exit(1);
});
What's happening:
  • We call the main() function to start the application

Complete Code

Here's the complete code to get you started with Heyzine and LangChain:

import { Composio } from '@composio/core';
import { LangchainProvider } from '@composio/langchain';
import { MultiServerMCPClient } from "@langchain/mcp-adapters";  
import { createAgent } from "langchain";
import * as readline from 'readline';
import 'dotenv/config';

const composioApiKey = process.env.COMPOSIO_API_KEY;
const userId = process.env.COMPOSIO_USER_ID;

if (!composioApiKey) throw new Error('COMPOSIO_API_KEY is not set');
if (!userId) throw new Error('COMPOSIO_USER_ID is not set');

async function main() {
    const composio = new Composio({
        apiKey: composioApiKey as string,
        provider: new LangchainProvider()
    });

    const session = await composio.create(
        userId as string,
        {
            toolkits: ['heyzine']
        }
    );

    const url = session.mcp.url;
    
    const client = new MultiServerMCPClient({
        "heyzine-agent": {
            transport: "http",
            url: url,
            headers: {
                "x-api-key": process.env.COMPOSIO_API_KEY
            }
        }
    });
    
    const tools = await client.getTools();
  
    const agent = createAgent({ model: "gpt-5", tools });
    
    let conversationHistory: any[] = [];
    
    console.log("Chat started! Type 'exit' or 'quit' to end the conversation.\n");
    console.log("Ask any Heyzine related question or task to the agent.\n");
    
    const rl = readline.createInterface({
        input: process.stdin,
        output: process.stdout,
        prompt: 'You: '
    });

    rl.prompt();

    rl.on('line', async (userInput: string) => {
        const trimmedInput = userInput.trim();
        
        if (['exit', 'quit', 'bye'].includes(trimmedInput.toLowerCase())) {
            console.log("\nGoodbye!");
            rl.close();
            process.exit(0);
        }
        
        if (!trimmedInput) {
            rl.prompt();
            return;
        }
        
        conversationHistory.push({ role: "user", content: trimmedInput });
        console.log("\nAgent is thinking...\n");
        
        const response = await agent.invoke({ messages: conversationHistory });
        conversationHistory = response.messages;
        
        const finalResponse = response.messages[response.messages.length - 1]?.content;
        console.log(`Agent: ${finalResponse}\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

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

Key features of this implementation:

  • Dynamic tool loading through Composio's Tool Router
  • Conversation history maintenance for context-aware responses
  • Async Python provides clean, efficient execution of agent workflows
You can extend this further by adding error handling, implementing specific business logic, or integrating additional Composio toolkits to create multi-app workflows.
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

Claude Agent SDK logo

Claude Agent SDK

Use Heyzine MCP with Claude Agent 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

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. LangChain 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