How to integrate Heyzine MCP with CrewAI

BOOK A CALLGET STARTED FOR FREE
Framework Integration Gradient
Heyzine Logo
CrewAI Logo
divider

Introduction

This guide walks you through connecting Heyzine to CrewAI using the Composio tool router. By the end, you'll have a working Heyzine agent that can convert this pdf to a flipbook instantly, get embed code for my latest flipbook, list all flipbooks i published this month, delete a flipbook by its name through natural language commands.

This guide will help you understand how to give your CrewAI 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.

TL;DR

Here's what you'll learn:
  • Get a Composio API key and configure your Heyzine connection
  • Set up CrewAI with an MCP enabled agent
  • Create a Tool Router session or standalone MCP server for Heyzine
  • Build a conversational loop where your agent can execute Heyzine operations

What is CrewAI?

CrewAI is a powerful framework for building multi-agent AI systems. It provides primitives for defining agents with specific roles, creating tasks, and orchestrating workflows through crews.

Key features include:

  • Agent Roles: Define specialized agents with specific goals and backstories
  • Task Management: Create tasks with clear descriptions and expected outputs
  • Crew Orchestration: Combine agents and tasks into collaborative workflows
  • MCP Integration: Connect to external tools through Model Context Protocol

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.

Supported Tools & Triggers

Tools
Create Flipbook LinkTool to create a direct flipbook link.
Create Flipbook AsynchronouslyTool to create a flipbook asynchronously.
Create Flipbook SyncTool to convert a PDF, DOCX, or PPTX into a flipbook synchronously via REST API.
Delete FlipbookTool to delete a flipbook.
Get API LimitsTool to retrieve API rate limits.
Get Flipbook Embed CodeTool to retrieve HTML embed code for a flipbook.
Get Flipbook ID ToolTool to retrieve HTML for Flipbook ID tool.
Get Flipbook ListTool to retrieve all flipbooks.
Get Flipbook Social MetadataTool to retrieve social metadata for a specific flipbook.
Get jQuery PluginTool to retrieve the Heyzine jQuery plugin script URL and usage snippet.
Get oEmbed DataTool to retrieve oEmbed data for a Heyzine flipbook.
Heyzine WebhooksTool to receive Heyzine webhook events for collected leads.
Setup Heyzine WebhooksHelper tool to validate prerequisites for Heyzine webhooks.
Update Flipbook Access ListTool to update the access list of a flipbook.
Update Flipbook Password ProtectionTool to update flipbook password protection settings.
Update Flipbook Social MetadataTool to update a flipbook's social metadata.
Heyzine Webhooks - LeadsTool to receive webhook events when new leads are collected on a flipbook form.

What is the Composio tool router, and how does it fit here?

What is Tool Router?

Composio's Tool Router 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 Tool Router

The tool router generates a secure MCP URL that your agents can access to perform actions.

How the Tool Router works

The Tool Router 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

Prerequisites

Before starting, make sure you have:
  • Python 3.9 or higher
  • A Composio account and API key
  • A Heyzine connection authorized in Composio
  • An OpenAI API key for the CrewAI LLM
  • Basic familiarity with Python

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.

Install dependencies

bash
pip install composio crewai crewai-tools python-dotenv
What's happening:
  • composio connects your agent to Heyzine via MCP
  • crewai provides Agent, Task, Crew, and LLM primitives
  • crewai-tools includes MCP helpers
  • python-dotenv loads environment variables from .env

Set up environment variables

bash
COMPOSIO_API_KEY=your_composio_api_key_here
USER_ID=your_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 with Composio
  • USER_ID scopes the session to your account
  • OPENAI_API_KEY lets CrewAI use your chosen OpenAI model

Import dependencies

python
from crewai import Agent, Task, Crew, LLM
from crewai_tools import MCPServerAdapter  # optional import if you plan to adapt tools
from composio import Composio
from dotenv import load_dotenv
import os
from crewai.mcp import MCPServerHTTP

load_dotenv()
What's happening:
  • CrewAI classes define agents and tasks, and run the workflow
  • MCPServerHTTP connects the agent to an MCP endpoint
  • Composio will give you a short lived Heyzine MCP URL

Create a Composio Tool Router session for Heyzine

python
composio = Composio(api_key=os.getenv("COMPOSIO_API_KEY"))
session = composio.create(
    user_id=os.getenv("USER_ID"),
    toolkits=["heyzine"],
)
url = session.mcp.url
What's happening:
  • You create a Heyzine only session through Composio
  • Composio returns an MCP HTTP URL that exposes Heyzine tools

Configure the LLM

python
llm = LLM(
    model="gpt-5-mini",
    api_key=os.getenv("OPENAI_API_KEY"),
)
What's happening:
  • CrewAI will call this LLM for planning and responses
  • You can swap in a different model if needed

Attach the MCP server and create the agent

python
toolkit_agent = Agent(
    role="Heyzine Assistant",
    goal="Help users interact with Heyzine through natural language commands",
    backstory=(
        "You are an expert assistant with access to Heyzine tools. "
        "You can perform various Heyzine operations on behalf of the user."
    ),
    mcps=[
        MCPServerHTTP(
            url=url,
            streamable=True,
            cache_tools_list=True,
            headers={"x-api-key": os.getenv("COMPOSIO_API_KEY")},
        ),
    ],
    llm=llm,
    verbose=True,
    max_iter=10,
)
What's happening:
  • MCPServerHTTP connects the agent to the Heyzine MCP endpoint
  • cache_tools_list saves a tools catalog for faster subsequent runs
  • verbose helps you see what the agent is doing

Add a REPL loop with Task and Crew

python
print("Chat started! Type 'exit' or 'quit' to end.\n")
print("Try asking the agent to perform Heyzine operations.\n")

conversation_context = ""

while True:
    user_input = input("You: ").strip()

    if user_input.lower() in ["exit", "quit", "bye"]:
        print("\nGoodbye!")
        break

    if not user_input:
        continue

    conversation_context += f"\nUser: {user_input}\n"
    print("\nAgent is thinking...\n")

    task = Task(
        description=(
            f"Based on the conversation history:\n{conversation_context}\n\n"
            f"Current user request: {user_input}\n\n"
            f"Please help the user with their Heyzine related request."
        ),
        expected_output="A helpful response addressing the user's request",
        agent=toolkit_agent,
    )

    crew = Crew(
        agents=[toolkit_agent],
        tasks=[task],
        verbose=False,
    )

    result = crew.kickoff()
    response = str(result)

    conversation_context += f"Agent: {response}\n"
    print(f"Agent: {response}\n")
What's happening:
  • You build a simple chat loop and keep a running context
  • Each user turn becomes a Task handled by the same agent
  • Crew executes the task and returns a response

Run the application

python
if __name__ == "__main__":
    main()
What's happening:
  • Standard Python entry point so you can run python crewai_heyzine_agent.py

Complete Code

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

python
# file: crewai_heyzine_agent.py
from crewai import Agent, Task, Crew, LLM
from crewai_tools import MCPServerAdapter  # optional
from composio import Composio
from dotenv import load_dotenv
import os
from crewai.mcp import MCPServerHTTP

load_dotenv()

def main():
    # Initialize Composio and create a Heyzine session
    composio = Composio(api_key=os.getenv("COMPOSIO_API_KEY"))
    session = composio.create(
        user_id=os.getenv("USER_ID"),
        toolkits=["heyzine"],
    )
    url = session.mcp.url

    # Configure LLM
    llm = LLM(
        model="gpt-5-mini",
        api_key=os.getenv("OPENAI_API_KEY"),
    )

    # Create Heyzine assistant agent
    toolkit_agent = Agent(
        role="Heyzine Assistant",
        goal="Help users interact with Heyzine through natural language commands",
        backstory=(
            "You are an expert assistant with access to Heyzine tools. "
            "You can perform various Heyzine operations on behalf of the user."
        ),
        mcps=[
            MCPServerHTTP(
                url=url,
                streamable=True,
                cache_tools_list=True,
                headers={"x-api-key": os.getenv("COMPOSIO_API_KEY")},
            ),
        ],
        llm=llm,
        verbose=True,
        max_iter=10,
    )

    print("Chat started! Type 'exit' or 'quit' to end the conversation.\n")
    print("Try asking the agent to perform Heyzine operations.\n")

    conversation_context = ""

    while True:
        user_input = input("You: ").strip()

        if user_input.lower() in ["exit", "quit", "bye"]:
            print("\nGoodbye!")
            break

        if not user_input:
            continue

        conversation_context += f"\nUser: {user_input}\n"
        print("\nAgent is thinking...\n")

        task = Task(
            description=(
                f"Based on the conversation history:\n{conversation_context}\n\n"
                f"Current user request: {user_input}\n\n"
                f"Please help the user with their Heyzine related request."
            ),
            expected_output="A helpful response addressing the user's request",
            agent=toolkit_agent,
        )

        crew = Crew(
            agents=[toolkit_agent],
            tasks=[task],
            verbose=False,
        )

        result = crew.kickoff()
        response = str(result)

        conversation_context += f"Agent: {response}\n"
        print(f"Agent: {response}\n")

if __name__ == "__main__":
    main()

Conclusion

You now have a CrewAI agent connected to Heyzine through Composio's Tool Router. The agent can perform Heyzine operations through natural language commands. Next steps:
  • Add role-specific instructions to customize agent behavior
  • Plug in more toolkits for multi-app workflows
  • Chain tasks for complex multi-step operations

How to build Heyzine MCP Agent with another framework

OpenAI Agents SDK

OpenAI Agents SDK

Use Heyzine MCP with OpenAI Agents SDK

Claude Agent SDK

Claude Agent SDK

Use Heyzine MCP with Claude Agent SDK

Google ADK

Google ADK

Use Heyzine MCP with Google ADK

LangChain

LangChain

Use Heyzine MCP with LangChain

Vercel AI SDK

Vercel AI SDK

Use Heyzine MCP with Vercel AI SDK

Mastra AI

Mastra AI

Use Heyzine MCP with Mastra AI

LlamaIndex

LlamaIndex

Use Heyzine MCP with LlamaIndex

FAQ

What are the differences in Tool Router MCP and Heyzine MCP?

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.

Can I use Tool Router MCP with CrewAI?

Yes, you can. CrewAI 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.

Can I manage the permissions and scopes for Heyzine while using Tool Router?

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.

How safe is my data with Composio Tool Router?

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.

Used by agents from

Context
ASU
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai
Context
ASU
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai
Context
ASU
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai

Never worry about agent reliability

We handle tool reliability, observability, and security so you never have to second-guess an agent action.

Book a call↗Get started for free