Vercel

Learn how to use Vercel with Composio

Overview

SLUG: VERCEL

Description

Vercel is a platform for frontend frameworks and static sites, enabling developers to host websites and web services that deploy instantly, scale automatically, and require minimal configuration.

Authentication Details

bearer_token
stringRequired
generic_id
string

Connecting to Vercel

Create an auth config

Use the dashboard to create an auth config for the Vercel toolkit. This allows you to connect multiple Vercel accounts to Composio for agents to use.

1

Select App

Navigate to Vercel.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Vercel Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4vercel_auth_config_id = "ac_YOUR_VERCEL_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10 # Replace this with a method to retrieve an API key from the user.
11 # Or supply your own.
12 user_api_key = input("[!] Enter API key")
13
14 connection_request = composio.connected_accounts.initiate(
15 user_id=user_id,
16 auth_config_id=auth_config_id,
17 config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18 )
19
20 # API Key authentication is immediate - no redirect needed
21 print(f"Successfully connected Vercel for user {user_id}")
22 print(f"Connection status: {connection_request.status}")
23
24 return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, vercel_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Vercel toolkit’s playground

For code examples, see the Tool calling guide and Provider examples.

Tool List

Tool Name: Add Environment Variable

Description

Tool to add an environment variable to a Vercel project. Use after confirming the project exists and you need to configure secrets or configuration values across environments before deployment. Example: "Add API_KEY=secret to production".

Action Parameters

comment
customEnvironmentIds
gitBranch
idOrName
stringRequired
key
stringRequired
slug
target
arrayRequired
teamId
type
stringRequired
upsert
value
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add Domain to Project

Description

Tool to attach a custom domain to a Vercel project. Use when you need to add a domain to a project for production or branch-specific deployments. After adding, the domain must be verified by completing the verification challenges returned in the response.

Action Parameters

customEnvironmentId
gitBranch
idOrName
stringRequired
name
stringRequired
redirect
redirectStatusCode
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add Domain to Project

Description

Tool to attach a custom domain to a Vercel project. Use when you need to add a domain to a project for production or branch-specific deployments. After adding, the domain must be verified by completing the verification challenges returned in the response.

Action Parameters

customEnvironmentId
gitBranch
idOrName
stringRequired
name
stringRequired
redirect
redirectStatusCode
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Check Artifact Exists

Description

Tool to check if a cache artifact exists by its hash. Use when verifying whether a cache artifact is already stored before upload or when validating artifact availability.

Action Parameters

hash
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Assign Alias to Deployment

Description

Tool to assign an alias to a specific Vercel deployment. Use when you need to associate a custom domain or subdomain with a deployment.

Action Parameters

alias
stringRequired
id
stringRequired
redirect
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Batch Remove Project Environment Variables

Description

Tool to batch remove environment variables from a Vercel project. Use when you need to delete multiple environment variables at once. More efficient than deleting variables one by one when removing multiple variables.

Action Parameters

idOrName
stringRequired
ids
arrayRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Buy Domains

Description

Tool to purchase multiple domains through Vercel's domain registrar. Use when registering new domains after checking availability and price. Important: Always check domain availability and price before attempting purchase. Some TLDs may require additional contact information fields.

Action Parameters

contactInformation
objectRequired
domains
arrayRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Buy Single Domain

Description

Tool to purchase a domain through Vercel's domain registrar. Use when you need to register and buy a domain after confirming availability and pricing.

Action Parameters

autoRenew
booleanRequired
contactInformation
objectRequired
domain
stringRequired
expectedPrice
numberRequired
teamId
years
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Check Cache Artifact Exists

Description

Tool to check if a cache artifact exists by its hash. Use when verifying whether a cache artifact is already stored before upload.

Action Parameters

hash
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Check Domain Availability

Description

Tool to check if a domain is available for registration. Use when you need to verify domain availability before purchase. IMPORTANT: Vercel only supports specific TLDs. Common supported TLDs include: .com, .net, .org, .io, .co, .dev, .app, .ai, .xyz, .me. Some TLDs are NOT supported (e.g., .cam, .berlin, .wales). For the full list, see: https://vercel.com/docs/domains/supported-domains

Action Parameters

domain
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Check Domain Price

Description

Tool to check the price for a domain before purchase. Use when evaluating cost and availability prior to domain registration.

Action Parameters

name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Check Domain Price (v4)

Description

Tool to check the price for a domain (deprecated endpoint). Use when evaluating the cost of domain registration, renewal, transfer, or redemption.

Action Parameters

name
stringRequired
slug
teamId
type

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Check Domain Status (Deprecated)

Description

Tool to check a domain availability (deprecated). Use when you need to verify if a domain is available for registration. Note: This endpoint is deprecated; consider using CheckDomainAvailability instead.

Action Parameters

name
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Auth Token

Description

Tool to create a new authentication token. Use when you need to programmatically generate a new token after validating permissions. Example: "Create auth token named my-token"

Action Parameters

name
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Auth Token

Description

Tool to create a new authentication token. Use when you need to programmatically generate a new auth token with optional expiration. Returns both token metadata and the bearer token value (only provided once).

Action Parameters

expiresAt
name
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Deployment

Description

Tool to create a new Vercel deployment. Use when you need to deploy files or a git repository to Vercel. For file-based deployments, provide the `name` and `files` array with file content. For git-based deployments, provide the `gitSource` object with repository details.

Action Parameters

customEnvironmentSlugOrId
deploymentId
files
forceNew
gitMetadata
gitSource
meta
monorepoManager
name
stringRequired
project
projectSettings
skipAutoDetectionConfirmation
slug
target
teamId
withLatestCommit

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create DNS Record

Description

Tool to create a new DNS record for a domain. Use when you need to add DNS records such as A, AAAA, CNAME, MX, TXT, SRV, or other record types to a domain managed in Vercel.

Action Parameters

comment
domain
stringRequired
https
mxPriority
name
stringRequired
slug
srv
teamId
ttl
type
stringRequired
value

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Edge Config

Description

Tool to create a new Edge Config for a Vercel project. Use when you need to define edge caching settings before deploying your project across a specified repository.

Action Parameters

description
name
stringRequired
projectId
stringRequired
slug
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Edge Config

Description

Tool to create a new Edge Config in Vercel. Use when you need to create edge configuration storage for dynamic data at the edge.

Action Parameters

items
slug
stringRequired
teamId
teamSlug

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Edge Config Token

Description

Tool to create a new token for a specific Edge Config. Use when you need a read-only access token after provisioning your Edge Config.

Action Parameters

edgeConfigId
stringRequired
label
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Edge Config Token

Description

Tool to create a new token for a specific Edge Config. Use when you need to generate an access token for an Edge Config.

Action Parameters

edgeConfigId
stringRequired
label
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create new deployment

Description

Tool to create a new deployment. Use when you need to deploy files or a Git commit to a Vercel project. Example for file deployment: { "name": "my-app", "files": [ {"file": "index.html", "data": "<html><body>Hello World</body></html>"}, {"file": "style.css", "data": "body { font-family: Arial; }"} ], "target": "production" } Example for Git source deployment (deploy from GitHub branch - uses latest commit): { "name": "my-app", "gitSource": { "type": "github", "repoId": "668449998", "ref": "main" } } Example for Git source deployment (deploy specific commit): { "name": "my-app", "gitSource": { "type": "github", "repoId": "668449998", "ref": "main", "sha": "a1b2c3d4e5f6g7h8i9j0" } } Note: repoId must be the numeric GitHub repository ID (NOT 'owner/repo'). Get it via: GET https://api.github.com/repos/{owner}/{repo} -> use the 'id' field. Example for redeployment: { "deploymentId": "dpl_Br7FSrRXuUkSHj7t7GVVadyuGvFg", "target": "production" }

Action Parameters

deploymentId
files
forceNew
gitMetadata
gitSource
meta
name
stringRequired
project
projectSettings
skipAutoDetectionConfirmation
slug
target
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create or Transfer Domain

Description

Tool to add an existing domain to the Vercel platform. Use when you need to add a domain to Vercel for DNS management or transfer a domain. Supports two methods: 'add' for adding existing domains and 'move-in' for transferring domains (requires authorization token).

Action Parameters

cdnEnabled
method
name
stringRequired
slug
teamId
token
zone

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Vercel Project

Description

Tool to create a new Vercel project. Use when automating project provisioning in CI/CD before deployment.

Action Parameters

composio_execution_message
gitRepository
name
stringRequired
skipAutoDetectionConfirmation
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Vercel Project (v2)

Description

Tool to create a new Vercel project with comprehensive configuration options. Use when you need to create a project with specific settings like environment variables, framework selection, Git repository connection, resource configuration, or deployment policies.

Action Parameters

buildCommand
commandForIgnoringBuildStep
devCommand
enableAffectedProjectsDeployments
enablePreviewFeedback
enableProductionFeedback
environmentVariables
framework
gitRepository
installCommand
name
stringRequired
oidcTokenConfig
outputDirectory
previewDeploymentSuffix
previewDeploymentsDisabled
publicSource
resourceConfig
rootDirectory
serverlessFunctionRegion
serverlessFunctionZeroConfigFailover
skipGitConnectDuringLink
slug
ssoProtection
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Project Environment Variables

Description

Tool to create environment variables in a Vercel project. Use when you need to configure secrets or configuration values across environments.

Action Parameters

_sensitive_dev_removed
comment
customEnvironmentIds
gitBranch
idOrName
stringRequired
key
stringRequired
slug
target
teamId
type
stringRequired
upsert
value
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Project Transfer Request

Description

Tool to create a project transfer request. Use when you need to initiate a transfer of a Vercel project to another account or team.

Action Parameters

callbackSecret
callbackUrl
idOrName
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Shared Environment Variable

Description

Tool to create one or more shared environment variables in Vercel. Use when you need to create environment variables that can be shared across multiple projects or applied to specific target environments. Supports creating 1-50 variables in a single request.

Action Parameters

applyToAllCustomEnvironments
evs
arrayRequired
projectId
slug
target
teamId
type

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Webhook

Description

Tool to create a webhook for receiving notifications about Vercel events. Use when you need to set up automated responses to deployment, domain, project, or other Vercel events.

Action Parameters

events
arrayRequired
projectIds
slug
teamId
url
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Dangerously Delete By Source Images

Description

Tool to dangerously delete edge cache by source image URLs. Use when you need to invalidate cached images from the edge network for a specific project.

Action Parameters

projectIdOrName
stringRequired
revalidationDeadlineSeconds
slug
srcImages
arrayRequired
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Dangerously Delete Cache By Tags

Description

Tool to dangerously delete edge cache by tags. Use when you need to purge cached content for specific cache tags in a Vercel project. WARNING: This permanently deletes cached content and cannot be undone.

Action Parameters

projectIdOrName
stringRequired
revalidationDeadlineSeconds
slug
tags
Required
target
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Vercel Alias

Description

Tool to delete an alias from Vercel. Use when you need to remove a deployment alias or custom domain alias after confirming the alias ID.

Action Parameters

aliasId
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Auth Token

Description

Tool to delete an authentication token. Use when you need to revoke a token programmatically after confirming its validity. Example: "Delete auth token with id abc123"

Action Parameters

tokenId
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Purge All Data Cache

Description

Tool to purge all data cache entries for a specific project. Use when you need to clear the entire data cache for a project.

Action Parameters

projectIdOrName
stringRequired
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Deployment

Description

Tool to delete a specific deployment by its unique ID. Use after confirming the deployment identifier to clean up unused or failed deployments.

Action Parameters

id
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Deployment (V2)

Description

Tool to delete a specific deployment by its unique ID or URL. Use when you need to remove a deployment from Vercel.

Action Parameters

id
stringRequired
slug
teamId
url

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Domain

Description

Tool to remove a domain by name from Vercel. Use when you need to delete a domain that is no longer needed.

Action Parameters

domain
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Edge Config

Description

Tool to delete an Edge Config by its unique identifier. Use when you need to permanently remove an Edge Config and all its associated data.

Action Parameters

edgeConfigId
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Edge Config Token

Description

Tool to delete one or more tokens from an Edge Config. Use when you need to revoke access tokens for a specific Edge Config.

Action Parameters

edgeConfigId
stringRequired
slug
teamId
tokens
arrayRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Edge Config Tokens

Description

Tool to delete tokens associated with a specific Edge Config. Use when you need to revoke one or more access tokens from an existing Edge Config by its ID.

Action Parameters

edgeConfigId
stringRequired
slug
teamId
tokens
arrayRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Edge Config Tokens (v2)

Description

Tool to delete one or more Edge Config tokens. Use when you need to revoke access tokens from an Edge Config. Note: The tokens array must contain the actual token values, not token IDs.

Action Parameters

edgeConfigId
stringRequired
slug
teamId
tokens
arrayRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Environment Variable

Description

Tool to delete a specific environment variable from a project. Use after verifying the correct variable ID to remove it.

Action Parameters

customEnvironmentId
id
stringRequired
idOrName
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Vercel Project

Description

Tool to delete a specific project by its ID or name. Use after confirming the correct project ID or name to permanently remove it.

Action Parameters

id
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Vercel Project (v2)

Description

Tool to delete a Vercel project by ID or name. Use after confirming the correct project identifier to permanently remove the project.

Action Parameters

idOrName
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Rolling Release Configuration

Description

Tool to delete rolling release configuration for a project. Use when you need to remove or disable rolling release configuration from a Vercel project.

Action Parameters

idOrName
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Shared Env Variable

Description

Tool to delete one or more shared environment variables. Use when you need to remove shared env vars by their IDs (up to 50 at a time).

Action Parameters

ids
arrayRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Vercel Webhook

Description

Tool to delete a specific webhook by its unique ID. Use after confirming the webhook identifier to remove the webhook configuration.

Action Parameters

id
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Deploy Edge Function

Description

Deploy edge functions to Vercel. Use when you need to deploy serverless functions that run on the Edge Runtime with fast cold starts and global distribution.

Action Parameters

files
arrayRequired
name
stringRequired
project
projectSettings
target
Defaults to production
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Download Cache Artifact

Description

Tool to download a cache artifact from Vercel by its hash. Use when retrieving cached build artifacts for deployments.

Action Parameters

hash
stringRequired
slug
teamId
xArtifactClientCi
xArtifactClientInteractive

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Edit Project Environment Variable

Description

Tool to edit an environment variable in a Vercel project. Use when you need to update an existing environment variable's value, type, target environments, or other properties. Requires both the project identifier and the environment variable ID.

Action Parameters

comment
customEnvironmentIds
gitBranch
id
stringRequired
idOrName
stringRequired
key
slug
target
teamId
type
value

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Filter Project Environment Variables

Description

Tool to retrieve environment variables of a Vercel project by id or name. Use when you need to list and filter environment variables for a specific project.

Action Parameters

customEnvironmentId
customEnvironmentSlug
decrypt
gitBranch
idOrName
stringRequired
slug
source
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Active Attack Status

Description

Tool to read active attack data from Vercel Firewall for a specific project. Use when you need to check if a project is under attack or retrieve security anomaly information.

Action Parameters

projectId
stringRequired
since
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Vercel Alias

Description

Tool to retrieve information about a Vercel alias by ID or alias name. Use when you need to get details of a specific alias.

Action Parameters

from
idOrAlias
stringRequired
projectId
since
slug
teamId
until

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get All Checks

Description

Tool to retrieve a list of all checks for a specific deployment. Use when you need to inspect check statuses and results for a deployment.

Action Parameters

deploymentId
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get All Log Drains

Description

Tool to retrieve a list of all log drains (deprecated). Use when you need to list all log drains configured for your account, team, or project.

Action Parameters

includeMetadata
projectId
projectIdOrName
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Auth Token Metadata

Description

Tool to retrieve metadata for an authentication token. Use when you need to inspect details of a specific token or get information about the current token being used.

Action Parameters

tokenId
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Auth Token Metadata

Description

Tool to retrieve metadata for an authentication token. Use when you need to inspect details of a specific token for auditing or debugging.

Action Parameters

tokenId
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Authenticated User

Description

Tool to get the authenticated user's profile. Use when you need to retrieve details about the currently authenticated user.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Bulk Domain Availability

Description

Tool to check availability for multiple domains at once. Use when you need to verify availability of multiple domain names efficiently in a single request. Supports checking up to 50 domains per request. Only domains with Vercel-supported TLDs can be checked.

Action Parameters

domains
arrayRequired
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get SSL/TLS Certificates

Description

Tool to retrieve SSL/TLS certificates for the authenticated user or team. Use after authentication to list active certificates.

Action Parameters

limit
since
slug
teamId
until

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Integration Configurations

Description

Tool to get configurations for the authenticated user or team. Use when you need to list integration configurations installed on an account or team.

Action Parameters

installationType
integrationIdOrSlug
slug
teamId
view
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Contact Info Schema

Description

Tool to retrieve the contact information schema for a domain's top-level domain (TLD). Use when you need to understand what contact information fields are required for a specific domain registration or transfer. Some TLDs require additional contact information beyond standard fields.

Action Parameters

domain
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Deployment by ID or URL

Description

Tool to get a deployment by ID or URL. Use when you need to retrieve detailed information about a specific deployment.

Action Parameters

idOrUrl
stringRequired
slug
teamId
withGitRepoInfo

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get deployment details

Description

Tool to retrieve detailed information about a specific deployment. Use after triggering a deployment and you need to inspect its status and configuration. Example: { "idOrUrl": "dpl_Br7FSrRXuUkSHj7t7GVVadyuGvFg" }

Action Parameters

idOrUrl
stringRequired
slug
teamId
withGitRepoInfo

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Deployment Events

Description

Tool to retrieve events related to a specific deployment. Use when monitoring or debugging deployment history or streaming real-time events. Example: "Get events for deployment dpl_xxx since 1540095775941."

Action Parameters

builds
delimiter
direction
stringDefaults to forward
follow
idOrUrl
stringRequired
limit
name
since
slug
statusCode
teamId
until

Action Response

data
arrayRequired
error
successful
booleanRequired

Tool Name: Get Deployment Events

Description

Tool to get deployment events for a specific Vercel deployment by ID or URL. Use when you need to retrieve build logs, event streams, or monitor deployment progress.

Action Parameters

builds
delimiter
direction
follow
idOrUrl
stringRequired
limit
name
since
slug
statusCode
teamId
until

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Deployment File Contents

Description

Tool to retrieve the contents of a specific file from a deployment. Use when you need to inspect or download file contents from a deployed application. The file contents are returned as a base64-encoded string.

Action Parameters

fileId
stringRequired
id
stringRequired
path
slug
teamId

Action Response

data
stringRequired
error
successful
booleanRequired

Tool Name: Get Deployment Logs

Description

Tool to retrieve logs for a specific Vercel deployment. Use when monitoring deployment execution, debugging issues, or analyzing deployment performance. Example: "Get logs for deployment dpl_xxx since 1540095775941."

Action Parameters

builds
direction
stringDefaults to forward
follow
idOrUrl
stringRequired
limit
Defaults to 100
since
slug
statusCode
teamId
until

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Deployment Runtime Logs

Description

Tool to retrieve runtime logs for a specific Vercel deployment by project and deployment ID. Use when you need to debug or monitor deployment execution with detailed runtime information.

Action Parameters

deploymentId
stringRequired
maxLogs
Defaults to 100
projectId
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Deployments

Description

Tool to list deployments from Vercel. Use when you need to retrieve deployment information for a project or team.

Action Parameters

app
branch
from
limit
projectId
projectIds
rollbackCandidate
sha
since
slug
state
target
teamId
to
until
users

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List DNS Records

Description

Tool to list existing DNS records for a domain. Use when you need to retrieve, audit, or verify DNS configuration for a domain managed in Vercel.

Action Parameters

domain
stringRequired
limit
since
slug
teamId
until

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Domain Information

Description

Tool to retrieve complete information for a single domain. Use when you need to check domain details, ownership verification status, nameserver configuration, or domain service type.

Action Parameters

domain
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Domain Availability

Description

Tool to get availability for a domain via the registrar endpoint. Use when you need to check if a domain can be registered.

Action Parameters

domain
stringRequired
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Domain Configuration

Description

Tool to get a domain's configuration details from Vercel. Use when you need to check how a domain is configured, what DNS records are recommended, or verify domain setup. Returns configuration status, accepted SSL challenges, and recommended DNS records (CNAME and IPv4).

Action Parameters

domain
stringRequired
projectIdOrName
slug
strict
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Domain Price

Description

Tool to get price data for a domain including purchase, renewal, and transfer costs. Use when evaluating domain pricing for registration, renewal, or transfer operations.

Action Parameters

domain
stringRequired
teamId
years

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Domains

Description

Tool to list all domains from Vercel. Use this to retrieve domain information including verification status, nameservers, and ownership details.

Action Parameters

limit
since
slug
teamId
until

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Domain Transfer Info

Description

Tool to get information required to transfer a domain to Vercel. Use when you need to check transfer availability or current status before initiating a transfer.

Action Parameters

domain
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get All Drains

Description

Tool to retrieve a list of all drains. Use this to get all configured drains for an account or team, including their delivery configurations and sources.

Action Parameters

includeMetadata
projectId
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Edge Config

Description

Tool to retrieve details of a specific Edge Config. Use when you need to inspect edge config metadata by ID before updating or deleting.

Action Parameters

edgeConfigId
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Edge Config

Description

Tool to retrieve detailed information about a specific Edge Config by ID. Use when you need to inspect edge config metadata including transfer status, sync information, and purpose details.

Action Parameters

edgeConfigId
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Edge Config Backup

Description

Tool to retrieve a specific backup version of an Edge Config. Use when you need to inspect or restore a previous version of edge config data.

Action Parameters

backupId
stringRequired
edgeConfigId
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Edge Config Backups

Description

Tool to retrieve backups for a specific Edge Config. Use when you need to list or inspect available backups for recovery purposes.

Action Parameters

edgeConfigId
stringRequired
limit
metadata
next
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Edge Config Item

Description

Tool to retrieve a specific item within an Edge Config. Use after obtaining the Edge Config ID and when you need to inspect or validate a particular configuration item by its key.

Action Parameters

edgeConfigId
stringRequired
edgeConfigItemKey
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Edge Config Items

Description

Tool to retrieve all items from a specific Edge Config. Use when you need to inspect all key-value pairs stored in an Edge Config.

Action Parameters

edgeConfigId
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Edge Configs

Description

Tool to retrieve all Edge Configs for an account or team. Use when you need to list all Edge Config definitions.

Action Parameters

slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Edge Config Schema

Description

Tool to retrieve the JSON schema of a specific Edge Config. Use when you need to inspect the schema definition of an edge config.

Action Parameters

edgeConfigId
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Edge Config Token

Description

Tool to retrieve details of a specific token associated with an Edge Config. Use when you need metadata for an existing Edge Config token.

Action Parameters

edgeConfigId
stringRequired
slug
teamId
token
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Edge Config Token Metadata

Description

Tool to get Edge Config token metadata. Use when you need to retrieve details about a specific token associated with an Edge Config.

Action Parameters

edgeConfigId
stringRequired
slug
teamId
token
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Edge Config Token Metadata

Description

Tool to get Edge Config token metadata. Use when you need to retrieve details about a specific Edge Config token.

Action Parameters

edgeConfigId
stringRequired
slug
teamId
token
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Edge Config Tokens

Description

Tool to get all tokens of an Edge Config. Use when you need to retrieve the complete list of tokens associated with a specific Edge Config.

Action Parameters

edgeConfigId
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Firewall Configuration

Description

Tool to retrieve firewall configuration for a Vercel project. Use when you need to inspect current firewall rules and settings.

Action Parameters

configVersion
stringRequired
projectId
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Integration Log Drains

Description

Tool to retrieve a list of Integration log drains (deprecated). Use when you need to list integration log drains configured for a team or account.

Action Parameters

slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Vercel Project

Description

Tool to retrieve information about a Vercel project by ID or name. Use when you need project metadata after obtaining its identifier.

Action Parameters

projectIdOrName
stringRequired
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Find Project by ID or Name

Description

Tool to find a project by ID or name with comprehensive details. Use when you need complete project metadata including configuration, deployments, security settings, and analytics.

Action Parameters

idOrName
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Project Custom Environments

Description

Tool to retrieve custom environments for a Vercel project. Use when you need to list all custom environments or filter by git branch.

Action Parameters

gitBranch
idOrName
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Project Domain

Description

Tool to retrieve details about a specific domain attached to a Vercel project. Use when you need to check domain configuration, verification status, redirect settings, or git branch associations.

Action Parameters

domain
stringRequired
idOrName
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Project Domains

Description

Tool to retrieve all domains attached to a Vercel project by project ID or name. Use when you need to verify domain configuration, check verification status, or audit domain settings.

Action Parameters

customEnvironmentId
gitBranch
idOrName
stringRequired
limit
order
production
redirect
redirects
since
slug
target
teamId
until
verified

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Project Environment Variable

Description

Tool to retrieve the decrypted value of an environment variable from a Vercel project. Use when you need to access the actual value of a specific environment variable by its ID.

Action Parameters

id
stringRequired
idOrName
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Project Members

Description

Tool to list all members of a Vercel project. Use when you need to retrieve member information, check access permissions, or audit project membership.

Action Parameters

idOrName
stringRequired
limit
search
since
slug
teamId
until

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Projects

Description

Tool to retrieve a list of projects from Vercel. Use this to get project information with optional filtering by repository, team, or other criteria.

Action Parameters

buildMachineTypes
deprecated
edgeConfigId
edgeConfigTokenId
elasticConcurrencyEnabled
excludeRepos
from
gitForkProtection
limit
repo
repoId
repoUrl
search
slug
staticIpsEnabled
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Rolling Release

Description

Tool to retrieve active rolling release information for a Vercel project. Use when you need to check the status of a gradual deployment rollout.

Action Parameters

idOrName
stringRequired
slug
state
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Rolling Release Billing Status

Description

Tool to retrieve the rolling release billing status for a Vercel project. Use when you need to check if rolling releases are available for a project based on the team's plan.

Action Parameters

idOrName
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Rolling Release Config

Description

Tool to get rolling release configuration for a Vercel project. Use when you need to retrieve the project-level rolling release settings that define how deployments are gradually rolled out.

Action Parameters

idOrName
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Runtime Logs

Description

Tool to retrieve runtime logs for a specific Vercel deployment. Use when monitoring deployment execution, debugging runtime issues, or analyzing deployment performance. Runtime logs show application behavior during execution, including errors and request information.

Action Parameters

deploymentId
stringRequired
projectId
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Shared Environment Variable

Description

Tool to retrieve the decrypted value of a Shared Environment Variable by id. Use when you need to inspect a specific shared environment variable value.

Action Parameters

id
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Supported TLDs

Description

Tool to retrieve all TLDs (top-level domains) supported by Vercel for domain registration. Use when you need to verify if a specific TLD is supported or to display available domain extensions.

Action Parameters

teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Team Details

Description

Tool to retrieve detailed information about a specific Vercel team by its ID. Use when you need team metadata, configuration, and membership details.

Action Parameters

slug
teamId
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Team Members

Description

Tool to list all members of a Vercel team. Use when you need to retrieve team member information, check team access permissions, or audit team membership.

Action Parameters

eligibleMembersForProjectId
excludeProject
limit
role
search
since
teamId
stringRequired
until

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get All Teams

Description

Tool to list all teams accessible to the authenticated user with detailed information. Use when you need comprehensive team data including membership, configuration, and settings.

Action Parameters

limit
since
until

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get TLD Price

Description

Tool to get pricing information for a specific top-level domain (TLD). Use when you need to check domain registration, renewal, or transfer costs.

Action Parameters

teamId
tld
stringRequired
years

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Firewall Events by Project

Description

Tool to retrieve firewall events and actions for a specific Vercel project. Use when monitoring security events, analyzing firewall blocks, or investigating suspicious activity on a project.

Action Parameters

endTimestamp
hosts
projectId
stringRequired
startTimestamp

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Webhook

Description

Tool to retrieve details of a specific webhook by ID. Use when you need to inspect webhook configuration, events, or metadata.

Action Parameters

id
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get List of Webhooks

Description

Tool to retrieve a list of all webhooks for the authenticated account or team. Use this to discover configured webhooks and their event subscriptions.

Action Parameters

projectId
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Invalidate Cache By Source Images

Description

Tool to invalidate edge cache by source image URLs. Use when you need to mark cached images as stale for specific source images. Invalidated images are revalidated in the background on the next request, ensuring zero latency impact for users.

Action Parameters

projectIdOrName
stringRequired
slug
srcImages
arrayRequired
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Invalidate Cache By Tags

Description

Tool to invalidate edge cache by tags. Use when you need to mark cached content as stale for specific cache tags. Invalidated content is revalidated in the background on the next request, ensuring zero latency impact for users.

Action Parameters

projectIdOrName
stringRequired
slug
tags
Required
target
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Vercel Aliases

Description

Tool to list all aliases for the authenticated user or team. Use when you need to retrieve aliases filtered by various criteria.

Action Parameters

domain
limit
projectId
rollbackDeploymentId
since
slug
teamId
until

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Vercel Aliases

Description

Tool to list aliases from Vercel API. Use when you need to retrieve aliases with optional filtering by domain, project, or time range.

Action Parameters

domain
from
limit
projectId
rollbackDeploymentId
since
slug
teamId
until

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List All Deployments

Description

Tool to list all deployments. Use after authenticating to retrieve deployments under your user or team context. Example: "List deployments for project QmX...".

Action Parameters

app
branch
limit
projectId
rollbackCandidate
sha
since
slug
state
target
teamId
until
users

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Auth Tokens

Description

Tool to list authentication tokens. Use when you need to retrieve all tokens for the current user or an optional team.

Action Parameters

teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Auth Tokens

Description

Tool to list authentication tokens for the current user. Use when you need to retrieve all auth tokens.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Deployment Aliases

Description

Tool to list all aliases assigned to a specific deployment. Use when you need to retrieve the aliases (custom domains or URLs) that point to a particular deployment.

Action Parameters

id
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Deployment Checks

Description

Tool to retrieve a list of checks for a specific deployment. Use after a deployment to inspect check statuses and results.

Action Parameters

deploymentId
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Deployment Files

Description

Tool to list all files in a specific deployment. Use when you need to inspect the file tree structure of a deployed application.

Action Parameters

id
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Edge Config Items

Description

Tool to retrieve a list of items within a specific Edge Config. Use when you need to inspect or manage all key–value items after creating an Edge Config.

Action Parameters

edgeConfigId
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Edge Configs

Description

Tool to list all Edge Configs. Use when you need to enumerate all Edge Config definitions for your account or team.

Action Parameters

slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Edge Config Tokens

Description

Tool to retrieve a list of tokens for a specific Edge Config. Use after obtaining an Edge Config's ID to list its tokens.

Action Parameters

edgeConfigId
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Environment Variables

Description

Tool to list environment variables for a specific project. Use when you need to inspect or page through the environment settings before deployment. Example: { "projectId": "prj_nos3l9LxEmu8dYCFBaUVlox26eRJ", "decrypt": false, "limit": 20 }

Action Parameters

decrypt
boolean
gitBranch
limit
integerDefaults to 20
projectId
stringRequired
until

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Git Namespaces

Description

Tool to list Git namespaces (organizations/users) by provider. Use this to discover available Git namespaces for integration with projects.

Action Parameters

host
provider

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Project Domains

Description

Tool to retrieve all domains attached to a Vercel project. Use when you need to verify domain configuration, check verification status, audit redirect/branch bindings, or before performing domain operations.

Action Parameters

customEnvironmentId
gitBranch
idOrName
stringRequired
limit
order
production
redirect
redirects
since
slug
target
teamId
until
verified

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List All Projects

Description

Tool to list all projects accessible to the authenticated user or team. Use this to retrieve project IDs and metadata for further operations.

Action Parameters

limit
search
since
teamId
until

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Promote Aliases

Description

Tool to get a list of aliases with status for the current promote operation. Use when you need to check the status of aliases during a promotion process for a specific project.

Action Parameters

failedOnly
limit
projectId
stringRequired
since
slug
teamId
until

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Shared Environment Variables

Description

Tool to list all shared environment variables for a team. Use when you need to retrieve or inspect shared environment variables across projects.

Action Parameters

exclude_ids
exclude_projectId
ids
projectId
search
slug
teamId

Action Response

data
arrayRequired
error
pagination
objectRequired
successful
booleanRequired

Tool Name: List All Teams

Description

Tool to list all teams accessible to the authenticated user. Use after authentication to retrieve their IDs and slugs.

Action Parameters

limit
since
until

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List User Events

Description

Tool to list user events. Use when you need to retrieve events generated by a user or team, such as logins, deployments, and team activities.

Action Parameters

limit
principalId
projectIds
since
slug
teamId
types
until
userId
withPayload

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Move Project Domain

Description

Tool to move a domain from one Vercel project to another. Use when you need to transfer domain ownership between projects.

Action Parameters

domain
stringRequired
gitBranch
idOrName
stringRequired
projectId
stringRequired
redirect
redirectStatusCode
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Patch Domain

Description

Tool to update or move an apex domain on Vercel. Use when you need to modify domain configuration (zone settings) or transfer a domain to another team. For 'update' operation, you can modify the zone configuration. For 'move-out' operation, provide a destination team ID.

Action Parameters

customNameservers
destination
domain
stringRequired
op
stringRequired
renew
slug
teamId
zone

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Edge Config Schema

Description

Tool to update the JSON Schema for an Edge Config. Use when you need to define or modify validation rules for Edge Config items.

Action Parameters

dryRun
edgeConfigId
stringRequired
requestBody
objectRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Team

Description

Tool to update a Vercel team's configuration. Use when you need to modify team settings like name, description, security policies, or deployment settings.

Action Parameters

avatar
defaultDeploymentProtection
defaultExpirationSettings
description
emailDomain
enablePreviewFeedback
enableProductionFeedback
hideIpAddresses
hideIpAddressesInLogDrains
name
previewDeploymentSuffix
regenerateInviteCode
remoteCaching
saml
sensitiveEnvironmentVariablePolicy
slug
teamId
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update URL Protection Bypass

Description

Tool to update the protection bypass for a URL. Use when you need to configure shareable links with TTL, revoke/regenerate links, set user-scoped access permissions, or manage alias protection overrides.

Action Parameters

id
stringRequired
override
revoke
scope
slug
teamId
ttl

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Pause Vercel Project

Description

Tool to pause a Vercel project. Use when you need to temporarily disable a project to prevent new deployments and stop serving traffic.

Action Parameters

projectId
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Vercel Firewall Configuration

Description

Tool to update firewall configuration for a Vercel project. Use when you need to enable/disable firewall, configure CRS rules, or manage custom firewall rules and IP restrictions.

Action Parameters

botIdEnabled
crs
firewallEnabled
booleanRequired
ips
managedRules
projectId
stringRequired
rules
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Query Artifact Information

Description

Tool to query information about artifacts by their hashes. Use when you need to retrieve metadata about one or more artifacts, including size, processing duration, and tags.

Action Parameters

hashes
arrayRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Read Firewall Configuration

Description

Tool to read firewall configuration for a Vercel project. Use when you need to inspect current firewall settings, IP rules, or custom security rules for a project.

Action Parameters

projectId
stringRequired
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Record Artifacts Cache Events

Description

Tool to record artifacts cache usage events. Use when tracking cache hits and misses for artifact hashes to monitor remote caching performance.

Action Parameters

events
arrayRequired
slug
teamId
x_artifact_client_ci
x_artifact_client_interactive

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Remove Domain from Project

Description

Tool to remove/detach a domain from a Vercel project. Use when you need to clean up or rollback domain associations from a project. Optionally removes redirecting domains too.

Action Parameters

domain
stringRequired
idOrName
stringRequired
removeRedirects
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Remove Domain from Project

Description

Tool to remove a domain from a Vercel project. Use when you need to detach a domain from a project or clean up domain associations.

Action Parameters

domain
stringRequired
idOrName
stringRequired
removeRedirects
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Remove Project Environment Variable

Description

Tool to remove an environment variable from a Vercel project. Use when you need to delete a specific environment variable by its ID.

Action Parameters

customEnvironmentId
id
stringRequired
idOrName
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete DNS Record

Description

Tool to delete a DNS record from a domain. Use when you need to remove an existing DNS record by its record ID and domain name.

Action Parameters

domain
stringRequired
recordId
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Request Delete User Account

Description

Tool to initiate user account deletion on Vercel. Use when a user wants to delete their account. This triggers a verification email to confirm the deletion request.

Action Parameters

reasons

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Promote Deployment to Production

Description

Tool to promote a deployment to production by pointing all production domains for a project to the given deployment. Use when you need to make a specific deployment live without rebuilding.

Action Parameters

deploymentId
stringRequired
projectId
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Search Git Repositories

Description

Tool to search and list Git repositories linked to a namespace by provider. Use this to discover available repositories for integration with Vercel projects.

Action Parameters

host
installationId
namespaceId
provider
query
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Remote Caching Status

Description

Tool to get the status of Remote Caching for the principal. Use when you need to check if Remote Caching is enabled, disabled, over limit, or paused.

Action Parameters

slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Test Drain Configuration

Description

Tool to validate a drain delivery configuration by sending a test request. Use when you need to verify that a drain endpoint is properly configured and can receive events before creating the actual drain.

Action Parameters

delivery
objectRequired
schemas
objectRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Transfer In Domain

Description

Tool to transfer a domain to Vercel from another registrar. Use when you need to migrate domain registration to Vercel. Before transferring, obtain the authorization code from the current registrar and verify the domain is unlocked and eligible for transfer.

Action Parameters

authCode
stringRequired
autoRenew
booleanRequired
contactInformation
objectRequired
domain
stringRequired
expectedPrice
numberRequired
teamId
years
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Unpause Vercel Project

Description

Tool to unpause a specific project by its ID. Use after identifying a paused project to enable auto assigning custom production domains and unblock the active Production Deployment.

Action Parameters

projectId
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Attack Challenge Mode

Description

Tool to update Attack Challenge mode for a Vercel project. Use when you need to enable or disable enhanced security protection against potential attacks. Attack Challenge mode adds an extra verification layer to protect deployments.

Action Parameters

attackModeActiveUntil
attackModeEnabled
booleanRequired
projectId
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update DNS Record

Description

Tool to update an existing DNS record. Use when you need to modify DNS record properties such as value, name, type, TTL, or comment. Ensure you have the record ID before calling this action.

Action Parameters

comment
https
mxPriority
name
recordId
stringRequired
slug
srv
teamId
ttl
type
value

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Edge Config

Description

Tool to update an existing Edge Config. Use when you need to rename the slug of an Edge Config for reorganization or migration purposes. Only the slug field may be updated; ensure you confirm the new slug before using.

Action Parameters

edgeConfigId
stringRequired
requestBody
objectRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Edge Config

Description

Tool to update an Edge Config by changing its slug. Use when you need to rename an Edge Config to reflect a new purpose or organizational structure.

Action Parameters

edgeConfigId
stringRequired
slug
stringRequired
teamId
teamSlug

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Edge Config Items

Description

Tool to update items within a specific Edge Config. Use when you need to batch modify, add, or remove key-value pairs in an existing Edge Config.

Action Parameters

dryRun
edgeConfigId
stringRequired
items
arrayRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Firewall Configuration

Description

Tool to update Vercel Firewall configuration for a project. Use when you need to enable/disable the firewall, modify firewall rules, or update firewall settings. Common actions include enabling the firewall ('firewallEnabled') or removing IP rules ('ip.remove').

Action Parameters

action
stringRequired
id
projectId
stringRequired
slug
teamId
value

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Vercel Project

Description

Tool to update an existing project. Use when you need to modify a Vercel project’s configuration before deployment. Use after confirming the project ID or name.

Action Parameters

autoAssignCustomDomainsUpdatedBy
autoExposeSystemEnvs
commandForIgnoringBuildStep
customerSupportCodeVisibility
enableAffectedProjectsDeployments
gitForkProtection
idOrName
stringRequired
oidcTokenConfig
outputDirectory
passwordProtection
publicSource
rootDirectory
serverlessFunctionRegion
slug
sourceFilesOutsideRootDirectory
ssoProtection
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Vercel Project (v2)

Description

Tool to update an existing Vercel project configuration. Use when you need to modify project settings such as framework, build commands, environment configuration, or deployment protection settings.

Action Parameters

autoAssignCustomDomains
autoAssignCustomDomainsUpdatedBy
autoExposeSystemEnvs
buildCommand
commandForIgnoringBuildStep
customerSupportCodeVisibility
devCommand
directoryListing
enableAffectedProjectsDeployments
enablePreviewFeedback
enableProductionFeedback
framework
gitForkProtection
gitLFS
idOrName
stringRequired
installCommand
name
nodeVersion
oidcTokenConfig
outputDirectory
passwordProtection
previewDeploymentSuffix
previewDeploymentsDisabled
publicSource
resourceConfig
rootDirectory
serverlessFunctionRegion
serverlessFunctionZeroConfigFailover
skipGitConnectDuringLink
slug
sourceFilesOutsideRootDirectory
ssoProtection
staticIps
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Project Data Cache

Description

Tool to update the data cache feature for a Vercel project. Use when you need to enable or disable data caching for a project's deployments.

Action Parameters

disabled
projectId
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Project Domain

Description

Tool to update a project domain in Vercel. Use when you need to modify domain settings such as git branch association, redirects, or redirect status codes for an existing project domain.

Action Parameters

domain
stringRequired
gitBranch
idOrName
stringRequired
redirect
redirectStatusCode
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Project Protection Bypass

Description

Tool to update protection bypass for automation on a Vercel project. Use when you need to generate, revoke, or update automation bypass secrets for deployment protection.

Action Parameters

generate
idOrName
stringRequired
revoke
slug
teamId
update

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Shared Env Variable

Description

Tool to update one or more shared environment variables. Use when you need to modify shared env var properties like value, target environments, or project linkages using their IDs.

Action Parameters

slug
teamId
updates
objectRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Project Static IPs

Description

Tool to configure Static IPs for a Vercel project. Use when you need to enable or configure Static IPs for builds or specific regions. Requires either 'builds' or 'regions' parameter to be provided.

Action Parameters

builds
idOrName
stringRequired
regions
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Upload Cache Artifact

Description

Tool to upload a cache artifact to Vercel. Use when you need to store build artifacts in Vercel's remote cache.

Action Parameters

artifact
objectRequired
hash
stringRequired
slug
teamId
x-artifact-client-ci
x-artifact-client-interactive
x-artifact-duration
x-artifact-tag

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Upload Deployment File

Description

Tool to upload deployment files to Vercel. Use when preparing files for a Vercel deployment. The uploaded file is stored and returns CDN URLs for use in deployment creation.

Action Parameters

contentLength
file_to_upload
objectRequired
slug
teamId
xNowDigest
xNowSize
xVercelDigest

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Verify Project Domain

Description

Tool to trigger verification for a project domain after DNS challenges are set. Use after adding a domain to a project and updating DNS records to complete domain verification.

Action Parameters

domain
stringRequired
idOrName
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Verify Project Domain

Description

Tool to verify a project domain after DNS challenges are configured. Use when you need to complete domain verification for a project after adding the required DNS records.

Action Parameters

domain
stringRequired
idOrName
stringRequired
slug
teamId

Action Response

data
objectRequired
error
successful
booleanRequired