Vercel Deployments & Domains
Lets an agent check on Vercel projects: list projects and their deployments, read a deployment's status and build events, review domains and DNS configuration, and list a project's environment variables. Curated from Vercel's official OpenAPI specification.
Connect this API to an AI agent Browse all specs
What you can do with Vercel Deployments & Domains via MCP
Every endpoint below becomes a governed tool your AI agent (Claude, ChatGPT, or a customer-facing VX agent) can call — with scoped permissions, sandbox testing, and audit logs.
| Method | Path | Operation | Description |
|---|---|---|---|
| GET | /v2/user |
getCurrentUser | Get the account that owns the token |
| GET | /v10/projects |
listProjects | List projects, optionally filtered by name |
| GET | /v9/projects/{idOrName} |
getProject | Get a project's settings and latest deployments |
| GET | /v7/deployments |
listDeployments | List deployments, filtered by project, state or target |
| GET | /v13/deployments/{idOrUrl} |
getDeployment | Get a deployment's status, URL and build details |
| GET | /v3/deployments/{idOrUrl}/events |
getDeploymentEvents | Get build log events for a deployment |
| GET | /v5/domains |
listDomains | List domains registered or added to the account |
| GET | /v9/projects/{idOrName}/domains |
listProjectDomains | List the domains attached to a project |
| GET | /v6/domains/{domain}/config |
getDomainConfig | Check whether a domain's DNS is configured correctly |
| GET | /v10/projects/{idOrName}/env |
listProjectEnvVars | List a project's environment variables (names and targets) |
Authentication
bearerToken
Bearer token — sent as Authorization: Bearer <token>
Vercel access token sent as Authorization: Bearer <token>.
How to get a credential
- Sign in to vercel.com and open Account Settings > Tokens (vercel.com/account/tokens).
- Click Create Token, give it a name (e.g.
VX Agents) and an expiration date. - Under Scope, choose the team whose projects the agent should see (or your personal account).
- Copy the token right away: Vercel shows it only once.
Permissions used
Vercel tokens are not scoped per endpoint; access follows the scope chosen above and your role in that team.
| Access | Operations |
|---|---|
| Account (read) | getCurrentUser |
| Projects (read) | listProjects, getProject, listProjectDomains, listProjectEnvVars |
| Deployments (read) | listDeployments, getDeployment, getDeploymentEvents |
| Domains (read) | listDomains, getDomainConfig |
Common errors
- 401 Unauthorized: the token is missing, expired or revoked. Create a new token.
- 403 Forbidden: the token's scope does not include this team, or
teamIdis missing for a team resource. PassteamId(orslug) or re-create the token with the right scope. - 400 Bad Request: a parameter has the wrong format (e.g.
since/untilmust be Unix milliseconds). - 429 Too Many Requests: rate limit reached; wait until the time in the
X-RateLimit-Resetheader.
Store the token as a VX Agents credential (Bearer token) so it is never pasted into chat.
Usage guide
Setup
- Add a Vercel access token (Account Settings > Tokens) as a Bearer credential. Scope it to the team whose projects you want the agent to see.
- For team projects, preset
teamId(starts withteam_, shown in Team Settings > General) orslugon every operation. Without it, calls only see your personal account. - Optionally preset
projectIdonlistDeploymentsto keep the agent focused on one project.
Check a project's deployments
getCurrentUserto confirm the token works and which account it belongs to.listProjects(usesearchto filter by name) to find the project id or name.listDeploymentswithprojectId, and optionallytarget=productionorstate=ERROR, to see recent deployments.getDeploymentwith the deployment id or URL for itsreadyState, commit metadata, aliases and error message.- For a failed build, call
getDeploymentEventswith the same id and read the last log lines for the error.
Check domains
listProjectDomainsfor the domains attached to a project, orlistDomainsfor every domain on the account.getDomainConfigwith a domain to see whether DNS ismisconfiguredand which records Vercel expects.
Good to know
- This spec is read-only: it cannot redeploy, promote, change DNS or edit env vars. Tell the user what to change in the Vercel dashboard instead.
- Never repeat environment variable values back to the user.
listProjectEnvVarsis for checking names and targets (production,preview,development). - Times (
createdAt,since,until) are Unix timestamps in milliseconds. - Deployment ids start with
dpl_. Most get operations also accept the deployment URL (e.g.my-app-abc123.vercel.app). - Lists are paginated: pass
pagination.nextfrom the response asuntil(deployments) orfrom(projects) to get the next page. Uselimit(max 100) to keep responses small. readyStatevalues:QUEUED,BUILDING,READY,ERROR,CANCELED.
How to use this spec
- Create a free VX Agents account (sandbox tools included).
- Open the marketplace and connect “Vercel Deployments & Domains” to an agent.
- Expose it as an MCP server for Claude/ChatGPT, or chat with it directly.