How to Use the Heyzine MCP in OpenAI Agents SDK

Automate your entire digital publishing workflow with Heyzine tools inside the safety of the OpenAI Agents SDK.

See Vinkius in Action

Works with every AI agent you already use

…and any MCP-compatible client

MCP Servers - Free for Subscribers

Connect Heyzine MCP to OpenAI Agents SDK

Create your Vinkius account to connect Heyzine to OpenAI Agents SDK and route execution through our secure gateway. The platform manages server hosting, runtime updates, and security layers. Configuration requires no manual server provisioning.

GDPR Free for Subscribers

Setup Heyzine with OpenAI Agents SDK

Ask AI about this MCP

ChatGPT

Claude

Perplexity

Build a Hands-Off Publishing Pipeline

Stop manually uploading PDFs. Give your agent a URL and let it run `convert_pdf_to_flipbook` to instantly create a new interactive document. It gets back a flipbook ID, ready for the next step. From there, a specialized agent can take over. It can use that ID to fetch stats with `get_flipbook_details` or apply a new look using `update_flipbook_design`. This is how you build a real publishing system, not just a one-off script. It's a proper handoff between agents, all tracked in your OpenAI dashboard.

Curate Bookshelves with Guardrails

Organizing your content is no longer a chore. Your agent can automatically manage collections by calling `add_flipbook_to_bookshelf` and `remove_flipbook_from_bookshelf`. You can set up rules to build bookshelves for different teams or topics. Here’s the key part: the OpenAI Agents SDK validates actions before they run. If your agent tries to remove a flipbook from the wrong collection, the built-in guardrails can stop it. This prevents the kind of mistakes that are common in less structured automation.

Monitor Your Heyzine MCP Server

Your production system needs to know what’s going on. The agent can use `get_account_info` to check your usage limits or `list_all_flipbooks` to get a full inventory of your content. It’s all available on demand. And if something feels off, your agent can ping `check_api_status` to make sure the Heyzine service is online. This isn't just about running tasks; it's about building a resilient system that can monitor its own dependencies. This MCP server gives your agent the tools to do just that.

Setup guide

Set up Heyzine MCP in OpenAI Agents SDK

Prerequisites

Python 3.10+ installed
openai-agents package (pip install openai-agents)
Active Vinkius subscription with a valid endpoint token

1

Install the SDK

Run pip install openai-agents to install the OpenAI Agents SDK. The MCP integration is built-in — no extra dependencies needed.
2

Connect via SSE transport

Use MCPServerSse with your Vinkius endpoint URL. Replace [YOUR_TOKEN_HERE] with your token from cloud.vinkius.com. The SDK auto-discovers all Heyzine tools at runtime.
3

Create your Agent

Pass the MCP to Agent(mcp_servers=[server]). The agent receives Heyzine tools as native definitions — JSON schemas resolve automatically.
4

Run the agent

Call Runner.run(agent, prompt) to execute. The agent invokes the appropriate Heyzine tools and returns structured results. Copy the full example on the right to get started.

agent.py

import asyncio
from agents import Agent, Runner
from agents.mcp import MCPServerSse

async def main():
    async with MCPServerSse(
        url="https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp"
    ) as server:
        agent = Agent(
            name="Heyzine Agent",
            instructions="You have access to Heyzine tools.",
            mcp_servers=[server],
        )
        result = await Runner.run(agent, "List recent transactions")
        print(result.final_output)

asyncio.run(main())

Get your connection token →

Independent Platform Disclaimer: Vinkius is an independent platform and is not affiliated with, endorsed by, sponsored by, verified by, or otherwise authorized by Heyzine. All third-party trademarks, logos, and brand names are the property of their respective owners. Their use on this website is strictly for informational purposes to identify service compatibility and interoperability.

Why Choose Vinkius

Vinkius connects your tools to AI with real-time monitoring and automatic cost savings — all from one dashboard.

Connect Heyzine now

Real-time monitoring

Live

visibility into every interaction

Connect your favorite tools to your AI and see exactly what's happening — every request, every response, in real time.

Built-in savings

60%

lower AI costs

Vinkius compresses data between your apps and your AI automatically. Lower bills every month — no configuration required.

Single dashboard

One

place for every integration

Every tool your AI connects to, managed from a single screen. One account, complete control.

Common questions about Heyzine MCP in OpenAI Agents SDK

It's automatic. When you connect the Heyzine MCP server, the SDK introspects the available tools like `convert_pdf_to_flipbook` and makes them available to your agent. There's no manual mapping or configuration needed.

Yes. The OpenAI Agents SDK is designed for this. You can configure guardrails and permissions that restrict which tools an agent can use, preventing accidental deletions or other unwanted actions on your Heyzine content.

Absolutely. The OpenAI platform provides full tracing for agent actions. You'll see a complete log of which agent called `update_flipbook_design`, with what parameters, and when it happened.

Not directly with this toolset. The Heyzine tools focus on managing flipbooks within existing bookshelves using functions like `add_flipbook_to_bookshelf`. Bookshelf creation itself is handled in the Heyzine web interface.

The server only processes the data needed for a specific tool. For `convert_pdf_to_flipbook`, it handles the PDF file content, and for others, it's just flipbook IDs and design settings. Vinkius isolates each transaction, and the OpenAI SDK adds another layer of security by validating tool inputs before they're even sent.

Use it with your favorite AI tools

Connect this server to Cursor, Claude, VS Code, and more.

OpenAI Agents SDK sdk-python

Google ADK sdk-python

Pydantic AI sdk-python

Vercel AI SDK sdk-typescript