How to integrate Zeplin MCP with Mastra AI

Connect Mastra AI to Zeplin MCP. List all project styleguides in zeplin, get all screens for a specific project, and more using natural language, with authentication handled for you.

Zeplin logoZeplin
Oauth2Api Key

Zeplin is a collaborative workspace for designers and developers to organize and hand off design projects. It streamlines design file sharing and communication for smoother product development.

24 Tools

Introduction

This guide walks you through connecting Zeplin to Mastra AI using the Composio tool router. By the end, you'll have a working Zeplin agent that can browse projects and screens, review screen annotations, manage styleguide colors and text styles, and invite project members through natural language commands.

This guide will help you understand how to give your Mastra AI agent real control over a Zeplin account through Composio's Zeplin MCP server.

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

For exact tool slugs and parameter tables, see the tool catalog in the Composio docs.

Also integrate Zeplin with

TL;DR

Here's what you'll learn:
  • Set up your environment so Mastra, OpenAI, and Composio work together
  • Create a Tool Router session in Composio that exposes Zeplin tools
  • Connect Mastra's MCP client to the Composio generated MCP URL
  • Fetch Zeplin tool definitions and attach them as a toolset
  • Build a Mastra agent that can reason, call tools, and return structured results
  • Run an interactive CLI where you can chat with your Zeplin agent

What is Mastra AI?

Mastra AI is a TypeScript framework for building AI agents with tool support. It provides a clean API for creating agents that can use external services through MCP.

Key features include:

  • MCP Client: Built-in support for Model Context Protocol servers
  • Toolsets: Organize tools into logical groups
  • Step Callbacks: Monitor and debug agent execution
  • OpenAI Integration: Works with OpenAI models via @ai-sdk/openai

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

The Zeplin MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Zeplin account. It provides structured and secure access to your Zeplin workspace, so your agent can perform actions like listing projects, fetching screens, exporting assets, managing components, and collaborating with your design team on your behalf.

  • Project and styleguide management: Let your agent list, fetch, or organize your Zeplin projects and associated styleguides for faster design handoff and reference.
  • Screen and asset retrieval: Automatically pull screen details, preview images, or export assets from any project directly into your workflow, no copy-paste required.
  • Component library access: Have your agent fetch, list, or update components from your shared libraries to keep your design system in sync.
  • Commenting and collaboration: Enable your agent to read, create, or manage comments on screens or components, streamlining feedback and design review cycles.
  • Resource linking and metadata extraction: Allow your agent to extract, organize, or provide direct links to design resources and metadata, making documentation and developer handoff seamless.

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:
  • Node.js 18 or higher
  • A Composio account with an active API key
  • An OpenAI API key
  • Basic familiarity with TypeScript
2

Getting API Keys for OpenAI and Composio

OpenAI API Key
  • Go to the OpenAI dashboard and create an API key.
  • You need credits or a connected billing setup to use the models.
  • Store the key somewhere safe.
Composio API Key
  • Log in to the Composio dashboard.
  • Go to Settings and copy your API key.
  • This key lets your Mastra agent talk to Composio and reach Zeplin through MCP.
3

Install dependencies

bash
npm install @composio/core @mastra/core @mastra/mcp @ai-sdk/openai dotenv

Install the required packages.

What's happening:

  • @composio/core is the Composio SDK for creating MCP sessions
  • @mastra/core provides the Agent class
  • @mastra/mcp is Mastra's MCP client
  • @ai-sdk/openai is the model wrapper for OpenAI
  • dotenv loads environment variables from .env
4

Set up environment variables

bash
COMPOSIO_API_KEY=your_composio_api_key_here
COMPOSIO_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 your requests to Composio
  • COMPOSIO_USER_ID tells Composio which user this session belongs to
  • OPENAI_API_KEY lets the Mastra agent call OpenAI models
5

Import libraries and validate environment

typescript
import "dotenv/config";
import { openai } from "@ai-sdk/openai";
import { Agent } from "@mastra/core/agent";
import { MCPClient } from "@mastra/mcp";
import { Composio } from "@composio/core";
import * as readline from "readline";

import type { AiMessageType } from "@mastra/core/agent";

const openaiAPIKey = process.env.OPENAI_API_KEY;
const composioAPIKey = process.env.COMPOSIO_API_KEY;
const composioUserID = process.env.COMPOSIO_USER_ID;

if (!openaiAPIKey) throw new Error("OPENAI_API_KEY is not set");
if (!composioAPIKey) throw new Error("COMPOSIO_API_KEY is not set");
if (!composioUserID) throw new Error("COMPOSIO_USER_ID is not set");

const composio = new Composio({
  apiKey: composioAPIKey as string,
});
What's happening:
  • dotenv/config auto loads your .env so process.env.* is available
  • openai gives you a Mastra compatible model wrapper
  • Agent is the Mastra agent that will call tools and produce answers
  • MCPClient connects Mastra to your Composio MCP server
  • Composio is used to create a Tool Router session
6

Create a Tool Router session for Zeplin

typescript
async function main() {
  const session = await composio.create(
    composioUserID as string,
    {
      toolkits: ["zeplin"],
    },
  );

  const composioMCPUrl = session.mcp.url;
  console.log("Zeplin MCP URL:", composioMCPUrl);
What's happening:
  • create spins up a short-lived MCP HTTP endpoint for this user
  • The toolkits array contains "zeplin" for Zeplin access
  • session.mcp.url is the MCP URL that Mastra's MCPClient will connect to
7

Configure Mastra MCP client and fetch tools

typescript
const mcpClient = new MCPClient({
    id: composioUserID as string,
    servers: {
      nasdaq: {
        url: new URL(composioMCPUrl),
        requestInit: {
          headers: session.mcp.headers,
        },
      },
    },
    timeout: 30_000,
  });

console.log("Fetching MCP tools from Composio...");
const composioTools = await mcpClient.getTools();
console.log("Number of tools:", Object.keys(composioTools).length);
What's happening:
  • MCPClient takes an id for this client and a list of MCP servers
  • The headers property includes the x-api-key for authentication
  • getTools fetches the tool definitions exposed by the Zeplin toolkit
8

Create the Mastra agent

typescript
const agent = new Agent({
    name: "zeplin-mastra-agent",
    instructions: "You are an AI agent with Zeplin tools via Composio.",
    model: "openai/gpt-5",
  });
What's happening:
  • Agent is the core Mastra agent
  • name is just an identifier for logging and debugging
  • instructions guide the agent to use tools instead of only answering in natural language
  • model uses openai("gpt-5") to configure the underlying LLM
9

Set up interactive chat interface

typescript
let messages: AiMessageType[] = [];

console.log("Chat started! Type 'exit' or 'quit' to end.\n");

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

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;
  }

  messages.push({
    id: crypto.randomUUID(),
    role: "user",
    content: trimmedInput,
  });

  console.log("\nAgent is thinking...\n");

  try {
    const response = await agent.generate(messages, {
      toolsets: {
        zeplin: composioTools,
      },
      maxSteps: 8,
    });

    const { text } = response;

    if (text && text.trim().length > 0) {
      console.log(`Agent: ${text}\n`);
        messages.push({
          id: crypto.randomUUID(),
          role: "assistant",
          content: text,
        });
      }
    } catch (error) {
      console.error("\nError:", error);
    }

    rl.prompt();
  });

  rl.on("close", async () => {
    console.log("\nSession ended.");
    await mcpClient.disconnect();
    process.exit(0);
  });
}

main().catch((err) => {
  console.error("Fatal error:", err);
  process.exit(1);
});
What's happening:
  • messages keeps the full conversation history in Mastra's expected format
  • agent.generate runs the agent with conversation history and Zeplin toolsets
  • maxSteps limits how many tool calls the agent can take in a single run
  • onStepFinish is a hook that prints intermediate steps for debugging

Complete Code

Here's the complete code to get you started with Zeplin and Mastra AI:

typescript
import "dotenv/config";
import { openai } from "@ai-sdk/openai";
import { Agent } from "@mastra/core/agent";
import { MCPClient } from "@mastra/mcp";
import { Composio } from "@composio/core";
import * as readline from "readline";

import type { AiMessageType } from "@mastra/core/agent";

const openaiAPIKey = process.env.OPENAI_API_KEY;
const composioAPIKey = process.env.COMPOSIO_API_KEY;
const composioUserID = process.env.COMPOSIO_USER_ID;

if (!openaiAPIKey) throw new Error("OPENAI_API_KEY is not set");
if (!composioAPIKey) throw new Error("COMPOSIO_API_KEY is not set");
if (!composioUserID) throw new Error("COMPOSIO_USER_ID is not set");

const composio = new Composio({ apiKey: composioAPIKey as string });

async function main() {
  const session = await composio.create(composioUserID as string, {
    toolkits: ["zeplin"],
  });

  const composioMCPUrl = session.mcp.url;

  const mcpClient = new MCPClient({
    id: composioUserID as string,
    servers: {
      zeplin: {
        url: new URL(composioMCPUrl),
        requestInit: {
          headers: session.mcp.headers,
        },
      },
    },
    timeout: 30_000,
  });

  const composioTools = await mcpClient.getTools();

  const agent = new Agent({
    name: "zeplin-mastra-agent",
    instructions: "You are an AI agent with Zeplin tools via Composio.",
    model: "openai/gpt-5",
  });

  let messages: AiMessageType[] = [];

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

  rl.prompt();

  rl.on("line", async (input: string) => {
    const trimmed = input.trim();
    if (["exit", "quit"].includes(trimmed.toLowerCase())) {
      rl.close();
      return;
    }

    messages.push({ id: crypto.randomUUID(), role: "user", content: trimmed });

    const { text } = await agent.generate(messages, {
      toolsets: { zeplin: composioTools },
      maxSteps: 8,
    });

    if (text) {
      console.log(`Agent: ${text}\n`);
      messages.push({ id: crypto.randomUUID(), role: "assistant", content: text });
    }

    rl.prompt();
  });

  rl.on("close", async () => {
    await mcpClient.disconnect();
    process.exit(0);
  });
}

main();

Conclusion

You've built a Mastra AI agent that can interact with Zeplin through Composio's Tool Router. You can extend this further by:
  • Adding other toolkits like Gmail, Slack, or GitHub
  • Building a web-based chat interface around this agent
  • Using multiple MCP endpoints to enable cross-app workflows
TOOLS

Supported Tools

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

Start OAuth authorization (PKCE)

Construct an OAuth 2.0 authorization URL for a Zeplin app to initiate the authorization code flow.

List Project Connected Components

List connected components in a Zeplin project by project ID.

List Project Colors

List colors defined in a Zeplin project by project ID, for example to retrieve its color tokens.

Update Project Color

Tool to update a color in a Zeplin project.

Get Zeplin Project by ID

Get a Zeplin project by ID to view details about a specific project.

Invite Project Member

Invite a user to a Zeplin project by handle, with an optional role.

List Project Text Styles

List text styles in a Zeplin project by project ID to retrieve its typography tokens.

Update Project Text Style

Update an existing text style in a Zeplin project by project and text style IDs.

Delete Screen Annotation

Tool to delete a screen annotation in Zeplin.

Get Screen Annotation

Tool to fetch a single screen annotation.

List Screen Annotations

List a page of annotations for a Zeplin screen by screen ID.

Update Screen Annotation

Update a screen annotation's content, position, or type by screen and annotation IDs.

List Screen Components

List components in a Zeplin screen by screen ID.

Get Screen Section

Tool to get a single screen section.

List Screen Sections

List screen sections in a Zeplin project by project ID.

Get Screen Version

Retrieve a specific Zeplin screen version by screen and version IDs to inspect its snapshot metadata.

Create Screen Version

Tool to create a new version of a screen.

List Screen Versions

List a page of versions for a Zeplin screen to enumerate its past snapshots.

Create Styleguide Color

Create a color token in a Zeplin styleguide.

List Styleguide Colors

List color tokens in a Zeplin styleguide by styleguide ID.

Update Styleguide Color

Update a color in a Zeplin styleguide.

List Styleguide Text Styles

List a page of text styles in a Zeplin styleguide to retrieve its typography tokens.

Update Styleguide Text Style

Update typography settings of a text style in a Zeplin styleguide.

List Personal Projects

List a page of projects in the current user's personal workspace.

FAQ

Frequently asked questions

Start with Zeplin.It takes 30 seconds.

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

Start building