mcp-on-vercel

A template Model Context Protocol (MCP) server for deployment on Vercel.

Update api/server.ts with your tools, prompts, and resources following the MCP TypeScript SDK documentation

Running locally

Run dev server:

# Install dependencies
npm install

# Install Vercel CLI
npm install vercel

# Run dev server
vercel dev

scripts/test-sse-client.mjs and test-streamable-http-client.mjs are MCP clients to test Server-Sent Events (SSE) and streamable HTTP transports with your MCP server, defaulting to the official Vercel MCP server demo at https://mcp-on-vercel.vercel.app if no URL provided. Also supports using bearer tokens / custom headers in general (the streamable HTTP client using the workaround from a comment on #436 in modelcontextprotocol/typescript-sdk).

Run test clients:

# Install MCP TypeScript SDK
npm install @modelcontextprotocol/sdk

# To test using the SSE client
node scripts/test-sse-client.mjs YOUR_MCP_SERVER_URL

# To test using the streamable HTTP client
node scripts/test-streamable-http-client.mjs YOUR_MCP_SERVER_URL

Deploying

Vercel

Easily deploy to Vercel:

Notes:

• Requires a Redis or Upstash database connected to the project through Vercel
• It's suggested to enable Fluid Compute
• Vercel environment variables can be accessed as expected, i.e. using process.env, no other setup required

Project files

• package.json - Node.js dependencies
• pnpm-lock.yaml - Node.js dependencies
• README.md - You are here!
• tsconfig.json - TypeScript config
• vercel.json - Vercel configuration

api/

• server.ts - MCP server; where tools, prompts, and resources are defined

public/

• index.html - Landing page

scripts/

• test-sse-client.mjs - Script to test the MCP server using a Server-Sent Events (SSE) cleint
• test-streamable-http-client.mjs - Script to test the MCP server using a streamable HTTP client

.github/workflows/

• cleandeployments.yml - Clean out old Vercel deployments from the GitHub deployments page