How to integrate Zeplin MCP with OpenAI Agents SDK

Connect OpenAI Agents SDK 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 the OpenAI Agents SDK 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 OpenAI Agents SDK 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:
  • Get and set up your OpenAI and Composio API keys
  • Install the necessary dependencies
  • Initialize Composio and create a Tool Router session for Zeplin
  • Configure an AI agent that can use Zeplin as a tool
  • Run a live chat session where you can ask the agent to perform Zeplin operations

What is OpenAI Agents SDK?

The OpenAI Agents SDK is a lightweight framework for building AI agents that can use tools and maintain conversation state. It provides a simple interface for creating agents with hosted MCP tool support.

Key features include:

  • Hosted MCP Tools: Connect to external services through hosted MCP endpoints
  • SQLite Sessions: Persist conversation history across interactions
  • Simple API: Clean interface with Agent, Runner, and tool configuration
  • Streaming Support: Real-time response streaming for interactive applications

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:
  • Composio API Key and OpenAI API Key
  • Primary know-how of OpenAI Agents SDK
  • A live Zeplin project
  • Some knowledge of Python or Typescript
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
3

Install dependencies

npm install @composio/openai-agents @openai/agents dotenv

Install the Composio SDK and the OpenAI Agents SDK.

4

Set up environment variables

bash
OPENAI_API_KEY=sk-...your-api-key
COMPOSIO_API_KEY=your-api-key
USER_ID=composio_user@gmail.com

Create a .env file and add your OpenAI and Composio API keys.

5

Import dependencies

import 'dotenv/config';
import { Composio } from '@composio/core';
import { OpenAIAgentsProvider } from '@composio/openai-agents';
import { Agent, hostedMcpTool, run, OpenAIConversationsSession } from '@openai/agents';
import * as readline from 'readline';
What's happening:
  • You're importing all necessary libraries.
  • The Composio and OpenAIAgentsProvider classes are imported to connect your OpenAI agent to Composio tools like Zeplin.
6

Set up the Composio instance

dotenv.config();

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

if (!composioApiKey) {
  throw new Error('COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key');
}
if (!userId) {
  throw new Error('USER_ID is not set');
}

// Initialize Composio
const composio = new Composio({
  apiKey: composioApiKey,
  provider: new OpenAIAgentsProvider(),
});
What's happening:
  • dotenv.config() loads your .env file so COMPOSIO_API_KEY and USER_ID are available as environment variables.
  • Creating a Composio instance using the API Key and OpenAIAgentsProvider class.
7

Create a Tool Router session

// Create Tool Router session for Zeplin
const session = await composio.create(userId as string, {
  toolkits: ['zeplin'],
});
const mcpUrl = session.mcp.url;

What is happening:

  • You give the Tool Router the user id and the toolkits you want available. Here, it is only zeplin.
  • The router checks the user's Zeplin connection and prepares the MCP endpoint.
  • The returned session.mcp.url is the MCP URL that your agent will use to access Zeplin.
  • This approach keeps things lightweight and lets the agent request Zeplin tools only when needed during the conversation.
8

Configure the agent

// Configure agent with MCP tool
const agent = new Agent({
  name: 'Assistant',
  model: 'gpt-5',
  instructions:
    'You are a helpful assistant that can access Zeplin. Help users perform Zeplin operations through natural language.',
  tools: [
    hostedMcpTool({
      serverLabel: 'tool_router',
      serverUrl: mcpUrl,
      headers: { 'x-api-key': composioApiKey },
      requireApproval: 'never',
    }),
  ],
});
What's happening:
  • We're creating an Agent instance with a name, model (gpt-5), and clear instructions about its purpose.
  • The agent's instructions tell it that it can access Zeplin and help with queries, inserts, updates, authentication, and fetching database information.
  • The tools array includes a hostedMcpTool that connects to the MCP server URL we created earlier.
  • The headers object includes the Composio API key for secure authentication with the MCP server.
  • requireApproval: 'never' means the agent can execute Zeplin operations without asking for permission each time, making interactions smoother.
9

Start chat loop and handle conversation

// Keep conversation state across turns
const conversationSession = new OpenAIConversationsSession();

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

console.log('\nComposio Tool Router session created.');
console.log('\nChat started. Type your requests below.');
console.log("Commands: 'exit', 'quit', or 'q' to end\n");

try {
  const first = await run(agent, 'What can you help me with?', { session: conversationSession });
  console.log(`Assistant: ${first.finalOutput}\n`);
} catch (e) {
  console.error('Error:', e instanceof Error ? e.message : e, '\n');
}

rl.prompt();

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

  if (['exit', 'quit', 'q'].includes(text.toLowerCase())) {
    console.log('Goodbye!');
    rl.close();
    process.exit(0);
  }

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

  try {
    const result = await run(agent, text, { session: conversationSession });
    console.log(`\nAssistant: ${result.finalOutput}\n`);
  } catch (e) {
    console.error('Error:', e instanceof Error ? e.message : e, '\n');
  }

  rl.prompt();
});

rl.on('close', () => {
  console.log('\n👋 Session ended.');
  process.exit(0);
});
What's happening:
  • The program prints a session URL that you visit to authorize Zeplin.
  • After authorization, the chat begins.
  • Each message you type is processed by the agent using run().
  • The responses are printed to the console.
  • Typing exit, quit, or q cleanly ends the chat.

Complete Code

Here's the complete code to get you started with Zeplin and OpenAI Agents SDK:

import 'dotenv/config';
import { Composio } from '@composio/core';
import { OpenAIAgentsProvider } from '@composio/openai-agents';
import { Agent, hostedMcpTool, run, OpenAIConversationsSession } from '@openai/agents';
import * as readline from 'readline';

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

if (!composioApiKey) {
  throw new Error('COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key');
}
if (!userId) {
  throw new Error('USER_ID is not set');
}

// Initialize Composio
const composio = new Composio({
  apiKey: composioApiKey,
  provider: new OpenAIAgentsProvider(),
});

async function main() {
  // Create Tool Router session
  const session = await composio.create(userId as string, {
    toolkits: ['zeplin'],
  });
  const mcpUrl = session.mcp.url;

  // Configure agent with MCP tool
  const agent = new Agent({
    name: 'Assistant',
    model: 'gpt-5',
    instructions:
      'You are a helpful assistant that can access Zeplin. Help users perform Zeplin operations through natural language.',
    tools: [
      hostedMcpTool({
        serverLabel: 'tool_router',
        serverUrl: mcpUrl,
        headers: { 'x-api-key': composioApiKey },
        requireApproval: 'never',
      }),
    ],
  });

  // Keep conversation state across turns
  const conversationSession = new OpenAIConversationsSession();

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

  console.log('\nComposio Tool Router session created.');
  console.log('\nChat started. Type your requests below.');
  console.log("Commands: 'exit', 'quit', or 'q' to end\n");

  try {
    const first = await run(agent, 'What can you help me with?', { session: conversationSession });
    console.log(`Assistant: ${first.finalOutput}\n`);
  } catch (e) {
    console.error('Error:', e instanceof Error ? e.message : e, '\n');
  }

  rl.prompt();

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

    if (['exit', 'quit', 'q'].includes(text.toLowerCase())) {
      console.log('Goodbye!');
      rl.close();
      process.exit(0);
    }

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

    try {
      const result = await run(agent, text, { session: conversationSession });
      console.log(`\nAssistant: ${result.finalOutput}\n`);
    } catch (e) {
      console.error('Error:', e instanceof Error ? e.message : e, '\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

This was a starter code for integrating Zeplin MCP with OpenAI Agents SDK to build a functional AI agent that can interact with Zeplin.

Key features:

  • Hosted MCP tool integration through Composio's Tool Router
  • SQLite session persistence for conversation history
  • Simple async chat loop for interactive testing
You can extend this by adding more toolkits, implementing custom business logic, or building a web interface around the agent.
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