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
| Parameter | Type | Required | Description |
|---|---|---|---|
code | string | Yes | The code of the project transfer request. |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
requestBody | object | No | Request body for this tool. |
Add a domain to a project.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
idOrName | string | Yes | The unique project identifier or the project name |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
requestBody | object | Yes | Request 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.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
repo | string | Yes | - | Repository as owner/name or a repository URL |
teamId | string | Yes | - | Team ID, or team slug for this tool |
provider | string | No | Inferred | Git provider; defaults to GitHub when the URL does not identify a provider |
projectName | string | No | Repository name | Project to create or reuse |
rootDirectory | string | No | - | Directory to build in a monorepo; applies to new projects |
deploy | boolean | No | true | Create 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
| Parameter | Type | Required | Description |
|---|---|---|---|
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
requestBody | object | No | Request body for this tool. |
Get a project by ID or name, including its configuration.
| Parameter | Type | Required | Description |
|---|---|---|---|
idOrName | string | Yes | The unique project identifier or the project name |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
Sample prompt: "Get details about my next-js-blog project"
Generate a project OIDC token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
idOrName | string | Yes | The project ID or name |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
requestBody | object | No | Request body for this tool. |
Retrieve project domains by project by id or name.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
idOrName | string | Yes | The unique project identifier or the project name |
production | string | No | Filters only production domains when set to true. Allowed values: "true", "false". Default: "false". |
target | string | No | Filters on the target of the domain. Can be either "production", "preview" Allowed values: "production", "preview". |
customEnvironmentId | string | No | The unique custom environment identifier within the project |
gitBranch | string | No | Filters domains based on specific branch. |
redirects | string | No | Excludes redirect project domains when "false". Includes redirect project domains when "true" (default). Allowed values: "true", "false". Default: "true". |
redirect | string | No | Filters domains based on their redirect target. |
verified | string | No | Filters domains based on their verification status. Allowed values: "true", "false". |
limit | number | No | Maximum number of domains to list from a request (max 100). |
since | number | No | Get domains created after this JavaScript timestamp. |
until | number | No | Get domains created before this JavaScript timestamp. |
order | string | No | Domains sort order by createdAt Allowed values: "ASC", "DESC". Default: "DESC". |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
List projects in your account or selected team. The tool also supports repository and project-setting filters.
| Parameter | Type | Required | Description |
|---|---|---|---|
from | string | No | Query only projects updated after the given timestamp or continuation token. |
gitForkProtection | string | No | Specifies whether PRs from Git forks should require a team member's authorization before it can be deployed Allowed values: "1", "0". |
limit | string | No | Limit the number of projects returned |
search | string | No | Search projects by the name field |
repo | string | No | Filter results by repo. Also used for project count |
repoId | string | No | Filter results by Repository ID. |
repoUrl | string | No | Filter results by Repository URL. |
excludeRepos | string | No | Filter results by excluding those projects that belong to a repo |
edgeConfigId | string | No | Filter results by connected Global Config ID |
edgeConfigTokenId | string | No | Filter results by connected Global Config Token ID |
deprecated | boolean | No | - |
elasticConcurrencyEnabled | string | No | Filter results by projects with elastic concurrency enabled Allowed values: "1", "0". |
staticIpsEnabled | string | No | Filter results by projects with Static IPs enabled Allowed values: "0", "1". |
buildMachineTypes | string | No | Filter 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. |
buildQueueConfiguration | string | No | Filter results by build queue configuration. SKIP_NAMESPACE_QUEUE includes projects without a configuration set. Allowed values: "SKIP_NAMESPACE_QUEUE", "WAIT_FOR_NAMESPACE_QUEUE". |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
Sample prompt: "Show me projects in my team"
Pause a project.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | The unique project identifier |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
requestBody | unknown | No | Request body for this tool. |
Unpause a project.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | The unique project identifier |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
requestBody | unknown | No | Request body for this tool. |
Update an existing project.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
idOrName | string | Yes | The unique project identifier or the project name |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
requestBody | object | Yes | Request body for this tool. |
Update Protection Bypass for Automation.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
idOrName | string | Yes | The unique project identifier or the project name |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
requestBody | object | Yes | Request body for this tool. |
Was this helpful?