How to integrate Vercel MCP with OpenAI Agents SDK

Trusted by
AWS
Glean
Zoom
Airtable

30 min · no commitment · see it on your stack

Vercel logo
OpenAI Agents SDK logo
divider

Introduction

This guide walks you through connecting Vercel to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Vercel agent that can deploy latest changes to your project, add api key as production environment variable, check if mydomain.com is available for purchase through natural language commands.

This guide will help you understand how to give your OpenAI Agents SDK agent real control over a Vercel account through Composio's Vercel MCP server.

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

Also integrate Vercel 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 Vercel
  • Configure an AI agent that can use Vercel as a tool
  • Run a live chat session where you can ask the agent to perform Vercel 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 Vercel MCP server, and what's possible with it?

The Vercel MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Vercel account. It provides structured and secure access to your Vercel projects and deployments, so your agent can perform actions like creating deployments, managing environment variables, handling edge configs, and checking domain statuses on your behalf.

  • Automated deployments and rollbacks: Easily instruct your agent to create new deployments or remove outdated ones, streamlining your release process without manual steps.
  • Environment variable management: Let your agent add or update sensitive configuration values across different environments, ensuring your projects are set up correctly before a deploy.
  • Edge configuration and token handling: Have your agent create new edge configs or generate secure tokens for read-only access, optimizing how your content is served globally.
  • Domain availability and pricing checks: Ask your agent to verify if a domain is available and fetch the latest price before you make a purchase decision.
  • Authentication token management: Enable your agent to create or revoke Vercel API tokens, giving you fine-grained control over programmatic access to your account.

Supported Tools & Triggers

Tools
Add Environment VariableTool to add an environment variable to a Vercel project.
Add Domain to ProjectTool to attach a custom domain to a Vercel project.
Assign Alias to DeploymentTool to assign an alias to a specific Vercel deployment.
Batch Remove Project Environment VariablesTool to batch remove environment variables from a Vercel project.
Buy DomainsTool to purchase multiple domains through Vercel's domain registrar.
Buy Single DomainTool to purchase a domain through Vercel's domain registrar.
Check Artifact ExistsTool to check if a cache artifact exists by its hash.
Check Domain AvailabilityTool to check if a domain is available for registration.
Check Domain PriceCheck pricing for a domain including purchase, renewal, and transfer costs.
Create Auth TokenTool to create a new authentication token.
Create DNS RecordTool to create a new DNS record for a domain.
Create Edge ConfigCreates a new Edge Config for storing key-value data at the edge.
Create Edge Config TokenCreate a read access token for a specific Edge Config.
Create new deploymentTool to create a new deployment.
Create or Transfer DomainTool to add an existing domain to the Vercel platform.
Create Vercel Project (v2)Tool to create a new Vercel project with comprehensive configuration options.
Create Project Transfer RequestTool to create a project transfer request.
Create Shared Environment VariableTool to create one or more shared environment variables in Vercel.
Create WebhookTool to create a webhook for receiving notifications about Vercel events.
Dangerously Delete By Source ImagesTool to dangerously delete edge cache by source image URLs.
Dangerously Delete Cache By TagsTool to dangerously delete edge cache by tags.
Delete Vercel AliasTool to delete an alias from Vercel.
Delete Auth TokenTool to delete an authentication token.
Purge All Data CacheTool to purge all data cache entries for a specific project.
Delete Deployment (V2)Permanently delete a Vercel deployment by its ID or URL.
Delete DNS RecordTool to delete a DNS record from a domain.
Delete DomainTool to remove a domain by name from Vercel.
Delete Edge ConfigTool to delete an Edge Config by its unique identifier.
Delete Edge Config Tokens (v2)Tool to delete one or more Edge Config tokens.
Delete Vercel Project (v2)Tool to delete a Vercel project by ID or name.
Remove Project Environment VariableTool to remove an environment variable from a Vercel project.
Delete Rolling Release ConfigurationTool to delete rolling release configuration for a project.
Delete Shared Env VariableTool to delete one or more shared environment variables.
Delete Vercel WebhookDelete a webhook by its unique ID to stop receiving event notifications.
Download Cache ArtifactDownload a cache artifact from Vercel's Remote Cache by its hash.
Edit Project Environment VariableTool to edit an environment variable in a Vercel project.
Filter Project Environment VariablesTool to retrieve environment variables of a Vercel project by id or name.
Get Active Attack StatusTool to read active attack data from Vercel Firewall for a specific project.
Get Vercel AliasTool to retrieve information about a Vercel alias by ID or alias name.
Query Artifact InformationTool to query information about artifacts by their hashes.
Get Auth Token MetadataTool to retrieve metadata for an authentication token.
Get Authenticated UserTool to get the authenticated user's profile.
Get Bulk Domain AvailabilityTool to check availability for multiple domains at once.
Get Remote Caching StatusTool to get the status of Remote Caching for the principal.
Get SSL/TLS CertificatesTool to retrieve SSL/TLS certificates for the authenticated user or team.
Get Integration ConfigurationsTool to get configurations for the authenticated user or team.
Get Contact Info SchemaTool to retrieve the contact information schema for a domain's top-level domain (TLD).
Get Deployment by ID or URLTool to get a deployment by ID or URL.
Get Deployment EventsTool to get deployment events for a specific Vercel deployment by ID or URL.
Get Deployment File ContentsRetrieve the contents of a specific file from a Vercel deployment.
Get Deployment Runtime LogsTool to retrieve runtime logs for a specific Vercel deployment by project and deployment ID.
Get DeploymentsTool to list deployments from Vercel.
Get Domain InformationTool to retrieve complete information for a single domain.
Get Domain ConfigurationTool to get a domain's configuration details from Vercel.
Get Domain Transfer InfoTool to get information required to transfer a domain to Vercel.
Get All DrainsTool to retrieve a list of all drains.
Get Edge ConfigTool to retrieve detailed information about a specific Edge Config by ID.
Get Edge Config BackupTool to retrieve a specific backup version of an Edge Config.
Get Edge Config ItemTool to retrieve a specific item within an Edge Config.
Get Edge Config SchemaTool to retrieve the JSON schema of a specific Edge Config.
Get Edge Config TokenTool to retrieve details of a specific token associated with an Edge Config.
Get Firewall ConfigurationTool to retrieve firewall configuration for a Vercel project.
List Git NamespacesTool to list Git namespaces (organizations/users) by provider.
Find Project by ID or NameTool to find a project by ID or name with comprehensive details.
Get Project DomainTool to retrieve details about a specific domain attached to a Vercel project.
List Project DomainsTool to retrieve all domains attached to a Vercel project.
Get Project Environment VariableTool to retrieve the decrypted value of an environment variable from a Vercel project.
Get ProjectsTool to retrieve a list of projects from Vercel.
List Promote AliasesTool to get a list of aliases with status for the current promote operation.
Get Rolling ReleaseTool to retrieve active rolling release information for a Vercel project.
Get Rolling Release Billing StatusTool to retrieve the rolling release billing status for a Vercel project.
Get Rolling Release ConfigTool to get rolling release configuration for a Vercel project.
Get Shared Environment VariableTool to retrieve the decrypted value of a Shared Environment Variable by id.
List Shared Environment VariablesTool to list all shared environment variables for a team.
Get Team DetailsRetrieves detailed information about a specific Vercel team by its ID or slug.
Get All TeamsTool to list all teams accessible to the authenticated user with detailed information.
Get TLD InfoTool to get information about a specific top-level domain (TLD).
Get TLD PriceTool to get pricing information for a specific top-level domain (TLD).
List User EventsTool to list user events.
Get WebhookTool to retrieve details of a specific webhook by ID.
Invalidate Cache By Source ImagesTool to invalidate edge cache by source image URLs.
Invalidate Cache By TagsTool to invalidate edge cache by tags.
List Vercel AliasesTool to list aliases from Vercel API.
List Auth TokensTool to list authentication tokens.
List Deployment AliasesTool to list all aliases assigned to a specific deployment.
List Deployment ChecksTool to retrieve a list of checks for a specific deployment.
List Deployment FilesTool to list all files in a specific deployment.
List DNS RecordsTool to list existing DNS records for a domain.
Get DomainsTool to list all domains from Vercel.
Get Edge Config BackupsTool to retrieve backups for a specific Edge Config.
Get Edge Config ItemsTool to retrieve all items from a specific Edge Config.
Get Edge ConfigsTool to retrieve all Edge Configs for an account or team.
Get Edge Config TokensTool to get all tokens of an Edge Config.
Get Firewall Events by ProjectRetrieve firewall events and security actions for a specific Vercel project.
Get Integration Log DrainsRetrieves a list of Integration log drains for a team or account.
Get Project Custom EnvironmentsTool to retrieve custom environments for a Vercel project.
Get Project MembersTool to list all members of a Vercel project.
Get Supported TLDsTool to retrieve all TLDs (top-level domains) supported by Vercel for domain registration.
Get Team MembersTool to list all members of a Vercel team.
Get List of WebhooksTool to retrieve a list of all webhooks for the authenticated account or team.
Move Project DomainTool to move a domain from one Vercel project to another.
Pause Vercel ProjectTool to pause a Vercel project.
Read Firewall ConfigurationTool to read firewall configuration for a Vercel project.
Record Artifacts Cache EventsTool to record artifacts cache usage events.
Remove Domain from ProjectTool to remove a domain from a Vercel project.
Update Vercel Firewall ConfigurationTool to update firewall configuration for a Vercel project.
Request Delete User AccountTool to initiate user account deletion on Vercel.
Promote Deployment to ProductionTool to promote a deployment to production by pointing all production domains for a project to the given deployment.
Search Git RepositoriesTool to search and list Git repositories linked to a namespace by provider.
Test Drain ConfigurationTool to validate a drain delivery configuration by sending a test request.
Transfer In DomainTool to transfer a domain to Vercel from another registrar.
Unlink Shared Environment VariableTool to disconnect a shared environment variable from a Vercel project.
Unpause Vercel ProjectTool to unpause a specific project by its ID.
Update Attack Challenge ModeTool to update Attack Challenge mode for a Vercel project.
Update DNS RecordTool to update an existing DNS record.
Patch DomainTool to update or move an apex domain on Vercel.
Update Edge ConfigTool to update an Edge Config by changing its slug.
Update Edge Config ItemsTool to update items within a specific Edge Config.
Update Edge Config SchemaTool to update the JSON Schema for an Edge Config.
Update Firewall ConfigurationTool to incrementally update Vercel Firewall configuration for a project using PATCH.
Update Vercel Project (v2)Tool to update an existing Vercel project configuration.
Update Project Data CacheTool to update the data cache feature for a Vercel project.
Update Project DomainTool to update a project domain in Vercel.
Update Project Protection BypassTool to update protection bypass for automation on a Vercel project.
Update Shared Env VariableTool to update one or more shared environment variables.
Update Project Static IPsTool to configure Static IPs for a Vercel project.
Update TeamTool to update a Vercel team's configuration.
Update URL Protection BypassTool to update the protection bypass for a URL.
Upload Cache ArtifactTool to upload a cache artifact to Vercel.
Upload Deployment FileTool to upload deployment files to Vercel.
Verify Project DomainAttempts to verify a project domain by checking if DNS challenges are correctly configured.

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

Prerequisites

Before starting, make sure you have:
  • Composio API Key and OpenAI API Key
  • Primary know-how of OpenAI Agents SDK
  • A live Vercel project
  • Some knowledge of Python or Typescript

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

Install dependencies

pip install composio_openai_agents openai-agents python-dotenv

Install the Composio SDK and the OpenAI Agents SDK.

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.

Import dependencies

import asyncio
import os
from dotenv import load_dotenv

from composio import Composio
from composio_openai_agents import OpenAIAgentsProvider
from agents import Agent, Runner, HostedMCPTool, SQLiteSession
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 Vercel.

Set up the Composio instance

load_dotenv()

api_key = os.getenv("COMPOSIO_API_KEY")
user_id = os.getenv("USER_ID")

if not api_key:
    raise RuntimeError("COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key")

# Initialize Composio
composio = Composio(api_key=api_key, provider=OpenAIAgentsProvider())
What's happening:
  • load_dotenv() loads your .env file so OPENAI_API_KEY and COMPOSIO_API_KEY are available as environment variables.
  • Creating a Composio instance using the API Key and OpenAIAgentsProvider class.

Create a Tool Router session

# Create a Vercel Tool Router session
session = composio.create(
    user_id=user_id,
    toolkits=["vercel"]
)

mcp_url = session.mcp.url

What is happening:

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

Configure the agent

# Configure agent with MCP tool
agent = Agent(
    name="Assistant",
    model="gpt-5",
    instructions=(
        "You are a helpful assistant that can access Vercel. "
        "Help users perform Vercel operations through natural language."
    ),
    tools=[
        HostedMCPTool(
            tool_config={
                "type": "mcp",
                "server_label": "tool_router",
                "server_url": mcp_url,
                "headers": {"x-api-key": api_key},
                "require_approval": "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 Vercel 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 dict includes the Composio API key for secure authentication with the MCP server.
  • require_approval: 'never' means the agent can execute Vercel operations without asking for permission each time, making interactions smoother.

Start chat loop and handle conversation

print("\nComposio Tool Router session created.")

chat_session = SQLiteSession("conversation_openai_toolrouter")

print("\nChat started. Type your requests below.")
print("Commands: 'exit', 'quit', or 'q' to end\n")

async def main():
    try:
        result = await Runner.run(
            agent,
            "What can you help me with?",
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")
    except Exception as e:
        print(f"Error: {e}\n")

    while True:
        user_input = input("You: ").strip()
        if user_input.lower() in {"exit", "quit", "q"}:
            print("Goodbye!")
            break

        result = await Runner.run(
            agent,
            user_input,
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")

asyncio.run(main())
What's happening:
  • The program prints a session URL that you visit to authorize Vercel.
  • After authorization, the chat begins.
  • Each message you type is processed by the agent using Runner.run().
  • The responses are printed to the console, and conversations are saved locally using SQLite.
  • Typing exit, quit, or q cleanly ends the chat.

Complete Code

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

import asyncio
import os
from dotenv import load_dotenv

from composio import Composio
from composio_openai_agents import OpenAIAgentsProvider
from agents import Agent, Runner, HostedMCPTool, SQLiteSession

load_dotenv()

api_key = os.getenv("COMPOSIO_API_KEY")
user_id = os.getenv("USER_ID")

if not api_key:
    raise RuntimeError("COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key")

# Initialize Composio
composio = Composio(api_key=api_key, provider=OpenAIAgentsProvider())

# Create Tool Router session
session = composio.create(
    user_id=user_id,
    toolkits=["vercel"]
)
mcp_url = session.mcp.url

# Configure agent with MCP tool
agent = Agent(
    name="Assistant",
    model="gpt-5",
    instructions=(
        "You are a helpful assistant that can access Vercel. "
        "Help users perform Vercel operations through natural language."
    ),
    tools=[
        HostedMCPTool(
            tool_config={
                "type": "mcp",
                "server_label": "tool_router",
                "server_url": mcp_url,
                "headers": {"x-api-key": api_key},
                "require_approval": "never",
            }
        )
    ],
)

print("\nComposio Tool Router session created.")

chat_session = SQLiteSession("conversation_openai_toolrouter")

print("\nChat started. Type your requests below.")
print("Commands: 'exit', 'quit', or 'q' to end\n")

async def main():
    try:
        result = await Runner.run(
            agent,
            "What can you help me with?",
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")
    except Exception as e:
        print(f"Error: {e}\n")

    while True:
        user_input = input("You: ").strip()
        if user_input.lower() in {"exit", "quit", "q"}:
            print("Goodbye!")
            break

        result = await Runner.run(
            agent,
            user_input,
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")

asyncio.run(main())

Conclusion

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

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.

How to build Vercel MCP Agent with another framework

FAQ

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

With a standalone Vercel MCP server, the agents and LLMs can only access a fixed set of Vercel tools tied to that server. However, with the Composio Tool Router, agents can dynamically load tools from Vercel and many other apps based on the task at hand, all through a single MCP endpoint.

Can I use Tool Router MCP with OpenAI Agents SDK?

Yes, you can. OpenAI Agents SDK 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 Vercel tools.

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

Yes, absolutely. You can configure which Vercel 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 Vercel data and credentials are handled as safely as possible.

Used by agents from

Context
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai
Context
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai
Context
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.