Skip to content
Docs

Projects

Create projects from scratch or connect an existing Git repository to Vercel. You can inspect and update project settings, manage domains and deployment protection, or pause and resume a project.

Accept project transfer request.

Parameters

ParameterTypeRequiredDescription
codestringYesThe code of the project transfer request.
teamIdstringNoTeam ID.
slugstringNoTeam slug.
requestBodyobjectNoRequest body for this tool.

Add a domain to a project.

Parameters

ParameterTypeRequiredDescription
idOrNamestringYesThe unique project identifier or the project name
teamIdstringNoTeam ID.
slugstringNoTeam slug.
requestBodyobjectYesRequest body for this tool.

Create or reuse a Vercel project linked to an accessible Git repository. By default, it creates a preview deployment from the repository's production branch.

ParameterTypeRequiredDefaultDescription
repostringYes-Repository as owner/name or a repository URL
teamIdstringYes-Team ID, or team slug for this tool
providerstringNoInferredGit provider; defaults to GitHub when the URL does not identify a provider
projectNamestringNoRepository nameProject to create or reuse
rootDirectorystringNo-Directory to build in a monorepo; applies to new projects
deploybooleanNotrueCreate a preview deployment; set false to link only

Sample prompt: "Create a Vercel project for my team's GitHub repository and deploy a preview"

Create a new project.

Parameters

ParameterTypeRequiredDescription
teamIdstringNoTeam ID.
slugstringNoTeam slug.
requestBodyobjectNoRequest body for this tool.

Get a project by ID or name, including its configuration.

ParameterTypeRequiredDescription
idOrNamestringYesThe unique project identifier or the project name
teamIdstringNoTeam ID.
slugstringNoTeam slug.

Sample prompt: "Get details about my next-js-blog project"

Generate a project OIDC token.

Parameters

ParameterTypeRequiredDescription
idOrNamestringYesThe project ID or name
teamIdstringNoTeam ID.
slugstringNoTeam slug.
requestBodyobjectNoRequest body for this tool.

Retrieve project domains by project by id or name.

Parameters

ParameterTypeRequiredDescription
idOrNamestringYesThe unique project identifier or the project name
productionstringNoFilters only production domains when set to true. Allowed values: "true", "false". Default: "false".
targetstringNoFilters on the target of the domain. Can be either "production", "preview" Allowed values: "production", "preview".
customEnvironmentIdstringNoThe unique custom environment identifier within the project
gitBranchstringNoFilters domains based on specific branch.
redirectsstringNoExcludes redirect project domains when "false". Includes redirect project domains when "true" (default). Allowed values: "true", "false". Default: "true".
redirectstringNoFilters domains based on their redirect target.
verifiedstringNoFilters domains based on their verification status. Allowed values: "true", "false".
limitnumberNoMaximum number of domains to list from a request (max 100).
sincenumberNoGet domains created after this JavaScript timestamp.
untilnumberNoGet domains created before this JavaScript timestamp.
orderstringNoDomains sort order by createdAt Allowed values: "ASC", "DESC". Default: "DESC".
teamIdstringNoTeam ID.
slugstringNoTeam slug.

List projects in your account or selected team. The tool also supports repository and project-setting filters.

ParameterTypeRequiredDescription
fromstringNoQuery only projects updated after the given timestamp or continuation token.
gitForkProtectionstringNoSpecifies whether PRs from Git forks should require a team member's authorization before it can be deployed Allowed values: "1", "0".
limitstringNoLimit the number of projects returned
searchstringNoSearch projects by the name field
repostringNoFilter results by repo. Also used for project count
repoIdstringNoFilter results by Repository ID.
repoUrlstringNoFilter results by Repository URL.
excludeReposstringNoFilter results by excluding those projects that belong to a repo
edgeConfigIdstringNoFilter results by connected Global Config ID
edgeConfigTokenIdstringNoFilter results by connected Global Config Token ID
deprecatedbooleanNo-
elasticConcurrencyEnabledstringNoFilter results by projects with elastic concurrency enabled Allowed values: "1", "0".
staticIpsEnabledstringNoFilter results by projects with Static IPs enabled Allowed values: "0", "1".
buildMachineTypesstringNoFilter results by effective build machine types. Accepts comma-separated values. Use "elastic" for projects with elastic selection and "default" for projects without a build machine type set.
buildQueueConfigurationstringNoFilter results by build queue configuration. SKIP_NAMESPACE_QUEUE includes projects without a configuration set. Allowed values: "SKIP_NAMESPACE_QUEUE", "WAIT_FOR_NAMESPACE_QUEUE".
teamIdstringNoTeam ID.
slugstringNoTeam slug.

Sample prompt: "Show me projects in my team"

Pause a project.

Parameters

ParameterTypeRequiredDescription
projectIdstringYesThe unique project identifier
teamIdstringNoTeam ID.
slugstringNoTeam slug.
requestBodyunknownNoRequest body for this tool.

Unpause a project.

Parameters

ParameterTypeRequiredDescription
projectIdstringYesThe unique project identifier
teamIdstringNoTeam ID.
slugstringNoTeam slug.
requestBodyunknownNoRequest body for this tool.

Update an existing project.

Parameters

ParameterTypeRequiredDescription
idOrNamestringYesThe unique project identifier or the project name
teamIdstringNoTeam ID.
slugstringNoTeam slug.
requestBodyobjectYesRequest body for this tool.

Update Protection Bypass for Automation.

Parameters

ParameterTypeRequiredDescription
idOrNamestringYesThe unique project identifier or the project name
teamIdstringNoTeam ID.
slugstringNoTeam slug.
requestBodyobjectYesRequest body for this tool.

Was this helpful?

supported.