How to Use the Heyzine MCP in LlamaIndex

Q: How do I configure the Heyzine MCP Server for LlamaIndex?

Run pip install llama-index-tools-mcp. Set up a BasicMCPClient with your endpoint, wrap it in McpToolSpec, and pass the asynchronous tool list to your FunctionAgent.

Q: How does LlamaIndex know if the Heyzine API is down?

Your agent executes checkapistatus before attempting any RAG operations that require live data. If it fails, the agent can fall back to cached vector store information.

Q: Can the agent manage bookshelves?

Yes. The agent uses addflipbooktobookshelf and removeflipbookfrombookshelf to organize collections based on user prompts or scheduled maintenance tasks.

Q: How does the MCP Server handle data privacy for account information?

Tools like getaccountinfo expose your subscription limits and document counts to the agent. The Vinkius zero-trust architecture ensures this sensitive telemetry only travels between the secured API and your local index, leaving no persistent footprint on the host machine.

Index Heyzine flipbook metadata and account stats directly into your LlamaIndex knowledge base.

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 LlamaIndex

Create your Vinkius account to connect Heyzine to LlamaIndex 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 LlamaIndex

Ask AI about this MCP

ChatGPT

Claude

Perplexity

Query Your Heyzine Catalog via MCP Server

The `list_all_flipbooks` tool pulls your entire publication history so your RAG application can index it. Your system ingests titles, creation dates, and flipbook IDs straight into a vector store. Users then ask natural language questions to find specific marketing materials. When someone needs deeper analytics, the agent runs `get_flipbook_details` on the specific match. It retrieves view counts and engagement metrics, allowing you to query which documents perform best across your entire collection.

Index Bookshelf Structures and Templates

The `get_bookshelf_details` tool extracts the organizational hierarchy of your digital libraries. LlamaIndex maps out which flipbooks live in which collections by pairing this with `list_bookshelf_flipbooks`. Designers can also query the system for brand standards. By indexing the output of `list_available_templates`, your RAG setup knows exactly which layouts exist before a user asks to generate a new document.

Generate and Track New Documents

The `convert_pdf_to_flipbook` tool lets your agent turn a raw PDF into an interactive asset during a query. The system takes a source URL, creates the flipbook, and immediately indexes the new URL and ID for future retrieval. If a user requests a visual change, the agent triggers `update_flipbook_design` to modify the active document. It then updates the local vector store with the fresh configuration data.

Setup guide

Set up Heyzine MCP in LlamaIndex

Prerequisites

Python 3.10+ installed
llama-index-tools-mcp package
Active Vinkius subscription with a valid endpoint token

1

Install dependencies
Run pip install llama-index-tools-mcp llama-index-llms-openai. The MCP tools package provides BasicMCPClient and McpToolSpec.
2

Connect with BasicMCPClient
Point BasicMCPClient to your Vinkius endpoint URL. Replace [YOUR_TOKEN_HERE] with your token from cloud.vinkius.com. Supports SSE and Streamable HTTP transports.
3

Convert to LlamaIndex tools
Call mcp_tool_spec.to_tool_list_async() to convert all Heyzine MCP tools into native FunctionTool objects that any LlamaIndex agent can use.
4

Run with any LLM
Create a FunctionAgent with the tools and your preferred LLM. Swap OpenAI for Anthropic, Gemini, or any LlamaIndex-supported provider.

agent.py

from llama_index.tools.mcp import BasicMCPClient, McpToolSpec
from llama_index.core.agent.workflow import FunctionAgent
from llama_index.llms.openai import OpenAI

# Connect to the MCP
mcp_client = BasicMCPClient(
    "https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp"
)
mcp_tool_spec = McpToolSpec(client=mcp_client)

# Convert MCP tools to LlamaIndex tools
tools = await mcp_tool_spec.to_tool_list_async()

# Create and run the agent
agent = FunctionAgent(
    tools=tools,
    llm=OpenAI(model="gpt-4o"),
    system_prompt="You have access to Heyzine tools.",
)
response = await agent.run("List recent Heyzine data")

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 LlamaIndex

Run `pip install llama-index-tools-mcp`. Set up a `BasicMCPClient` with your endpoint, wrap it in `McpToolSpec`, and pass the asynchronous tool list to your `FunctionAgent`.

The MCP Server retrieves metadata, IDs, and account stats via tools like `get_flipbook_details`. You index the structural data and URLs, but the server does not extract the raw text from the pages themselves.

Your agent executes `check_api_status` before attempting any RAG operations that require live data. If it fails, the agent can fall back to cached vector store information.

Yes. The agent uses `add_flipbook_to_bookshelf` and `remove_flipbook_from_bookshelf` to organize collections based on user prompts or scheduled maintenance tasks.

Tools like `get_account_info` expose your subscription limits and document counts to the agent. The Vinkius zero-trust architecture ensures this sensitive telemetry only travels between the secured API and your local index, leaving no persistent footprint on the host machine.

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