Use This MCP server To

Retrieve deployment details by ID or URL Track deployment events for monitoring Cancel ongoing Vercel deployments List files associated with a deployment Integrate Vercel deployment management into AI workflows Automate deployment status checks within development tools

README

vercel-mcp

An MCP server that connects to Vercel API.

Usage

Cursor

To install in a project, add the MCP server to your .cursor/mcp.json:

{
	"mcpServers": {
		"vercel": {
			"command": "npx",
			"args": ["vercel-mcp VERCEL_API_KEY=<YOUR_API_KEY>"],

		}
	}
}

To install globally, add this command to your Cursor settings:

npx vercel-mcp VERCEL_API_KEY=<your-vercel-api-key>

Windsurf

Add the MCP server to your ~/.codeium/windsurf/mcp_config.json file:

{
	"mcpServers": {
		"vercel": {
			"command": "npx",
			"args": ["vercel-mcp VERCEL_API_KEY=<YOUR_API_KEY>"]
		}
	}
}

Tools

This MCP server provides the following tools for interacting with the Vercel API:

Deployments

getVercelDeploymentEvents - Get deployment events by deployment ID and build ID
getVercelDeployment - Get a deployment by ID or URL
cancelVercelDeployment - Cancel a deployment
listVercelDeploymentFiles - List deployment files
getVercelDeploymentFileContents - Get deployment file contents
getVercelDeployments - List deployments
deleteVercelDeployment - Delete a deployment

DNS

getVercelDNSRecords - List DNS records for a domain
createVercelDNSRecord - Create a DNS record for a domain
updateVercelDNSRecord - Update a DNS record
deleteVercelDNSRecord - Delete a DNS record

Domains

getVercelDomainConfig - Get a Domain's configuration
getVercelDomain - Get information for a single domain
getVercelDomains - List all domains for the authenticated user or team

Projects

getVercelProjects - Retrieve a list of projects
updateVercelProject - Update an existing project
getVercelProjectDomains - Retrieve project domains by project id or name
getVercelProjectDomain - Get a project domain
updateVercelProjectDomain - Update a project domain
removeVercelProjectDomain - Remove a domain from a project
addVercelProjectDomain - Add a domain to a project
verifyVercelProjectDomain - Verify project domain

Environment Variables

filterVercelProjectEnvs - Retrieve the environment variables of a project
getVercelProjectEnv - Retrieve the decrypted value of an environment variable
createVercelProjectEnv - Create one or more environment variables
removeVercelProjectEnv - Remove an environment variable
editVercelProjectEnv - Edit an environment variable

vercel-api-mcp FAQ

How do I install vercel-api-mcp in my project?

Add the MCP server to your .cursor/mcp.json with the command 'npx vercel-mcp VERCEL_API_KEY=<YOUR_API_KEY>'.

Can vercel-api-mcp be installed globally?

Yes, you can install it globally by running 'npx vercel-mcp VERCEL_API_KEY=<your-vercel-api-key>'.

What tools does vercel-api-mcp provide?

It provides tools to get deployment events, retrieve deployments, cancel deployments, and list deployment files.

How do I configure vercel-api-mcp for Windsurf?

Add the MCP server configuration to your ~/.codeium/windsurf/mcp_config.json file with the appropriate command and API key.

Is an API key required to use vercel-api-mcp?

Yes, you must provide your Vercel API key as an environment variable to authenticate requests.

Can vercel-api-mcp handle deployment cancellations?

Yes, it includes a tool to cancel ongoing Vercel deployments by deployment ID.

Does vercel-api-mcp support listing deployment files?

Yes, it can list files associated with a specific deployment for inspection or analysis.