---
title: "Vercel"
description: "Read project summaries and deployment metadata through the official Vercel REST API. Uses your scoped access token and an optional connection-bound team ID. Leave team ID blank only for personal-account access. Model inp"
---

> Documentation Index
> Fetch the complete documentation index at: https://help.tooluse.net/llms.txt
> Use this file to discover all available pages before exploring further.

# Vercel

<p>Read project summaries and deployment metadata through the official Vercel REST API. Uses your scoped access token and an optional connection-bound team ID. Leave team ID blank only for personal-account access. Model input cannot change the team. This subset does not deploy code, trigger builds, change domains or read environment-variable values. One explicit request/page per invocation, without retries or automatic pagination.</p>

<details data-command-index><summary>What you can do (3)</summary>
<h2>What you can do</h2>
<p>Available commands: 3 (3 read, 0 write). Enable only the commands your application needs.</p>
<div class="nb-table-scroll"><table>
<thead>
<tr>
<th>Command</th>
<th>Effect</th>
</tr>
</thead>
<tbody><tr>
<td><a href="https://help.tooluse.net/integrations/vercel#command-vercel-projects-list">List accessible projects</a> — <code>vercel.projects.list</code></td>
<td>Read</td>
</tr>
<tr>
<td><a href="https://help.tooluse.net/integrations/vercel#command-vercel-projects-get">Read project summary</a> — <code>vercel.projects.get</code></td>
<td>Read</td>
</tr>
<tr>
<td><a href="https://help.tooluse.net/integrations/vercel#command-vercel-deployments-list">List deployment metadata</a> — <code>vercel.deployments.list</code></td>
<td>Read</td>
</tr>
</tbody></table>
</div>
</details>
<h2>Connect and use</h2>

<p><a href="https://www.tooluse.net/tools/integrations/vercel">Connect and use</a></p>
<p>Open the integration&#39;s connection form to check the available credential source. The source has not been resolved for this documentation export. The instructions below apply when using your own provider account.</p>
<h2>Get your provider credentials</h2>
<p>Follow these steps for Vercel, then enter the issued values in the connection form below.</p>
<ol>
<li>Open Vercel Account Settings → Tokens and create an access token with an expiry and the narrowest appropriate scope. Enter it in Vercel access token. For a team, copy the Team ID from that team&#39;s General Settings into Vercel team ID; leave this field blank only for personal-account access. Save the selected read commands and create a scoped Tooluse.net API key for your client. This connection returns project and deployment summaries and excludes environment-variable values and security configuration.</li>
</ol>
<p><a href="https://vercel.com/account/settings/tokens">Official credential setup</a></p>
<h2>Where to enter credentials</h2>
<p>In the integration page, sign in, choose your workspace and open Connect. If a <strong>Credentials</strong> choice is shown, select <strong>Use my credentials</strong>. Fill the following connection fields and save. Provider credentials belong in this form, never in an MCP configuration or tool input.</p>
<div class="nb-table-scroll"><table>
<thead>
<tr>
<th>Connection field</th>
<th>Requirement</th>
</tr>
</thead>
<tbody><tr>
<td>Vercel access token</td>
<td>Required</td>
</tr>
<tr>
<td>Vercel team ID (blank for personal account)</td>
<td>Optional</td>
</tr>
</tbody></table>
</div><p>Open API keys and create a Tooluse.net key for the enabled commands.</p>
<p>Set TOOLUSE_API_KEY in your client and use the shared MCP configuration.</p>
<p><a href="https://help.tooluse.net/clients">Configure Claude Code, Codex or Cursor once</a></p>

<h2>Permissions and results</h2>

<p>If you have more than one workspace, check the selected workspace in the connection or API-key dialog before saving. Roles, enabled commands, expiry and revocation use Tooluse.net&#39;s existing permissions. Disabling a connection or revoking a key immediately prevents new calls.</p>

<p>Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.</p>

<p>Your connection&#39;s daily allowance and key permissions also apply. Adding a connection does not make a provider request.</p>

<p>Calls return the shared execution receipt and a Claude tool_result. Provider output varies by operation; consult the provider documentation for its response fields. Unconfirmed calls should be checked before retrying.</p>

<h2>Call from your client</h2>

<p>Use the shared MCP configuration. Refresh your client&#39;s tool list after saving the connection or changing key permissions, then call the returned tool name with the example input below.</p>

<p><a href="https://help.tooluse.net/clients">Configure Claude Code, Codex or Cursor once</a></p>

<h2>Discover your enabled tools</h2>

<p>List permitted tools in Claude format. Read every page using page and size (maximum 100) until all results have been received. Use the returned name, not a catalog capability identifier, in the tool_use block.</p>

<pre><code class="language-bash">curl 'https://api.tooluse.net/v1/tools' \
  -H "Authorization: Bearer $TOOLUSE_API_KEY"
</code></pre>

<p>Find this command in the tool list permitted by your key. Replace svc_FROM_YOUR_TOOL_LIST with its returned name. Use a new Idempotency-Key for each new call and retain it when retrying that same call.</p>

<h2>HTTP call</h2>

<pre><code class="language-bash">curl 'https://api.tooluse.net/v1/tool-calls' \
  -H "Authorization: Bearer $TOOLUSE_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: replace-with-a-new-call-id' \
  --data '{
  "type": "tool_use",
  "id": "toolu_example",
  "name": "svc_FROM_YOUR_TOOL_LIST",
  "input": {
    "query": {
      "limit": 20
    }
  }
}'
</code></pre>

<p>Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.</p>

<h2>Commands</h2>

<details id="command-vercel-projects-list">
<summary><span>List accessible projects — <code>vercel.<wbr>projects.<wbr>list</code></span></summary>
<p>Read one page of project metadata for the personal account or team bound to this connection. Use the response continuation value explicitly; this does not deploy code or read environment-variable values.</p>

<p>This is a read operation. Provider rate limits and data access rules still apply.</p>

<p><a href="https://www.tooluse.net/tools/integrations/vercel?command=vercel.projects.list">Connect and use</a></p>

<p><strong>Parameters</strong></p>

<p>Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.</p>

<div class="nb-table-scroll"><table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Required in parent</th>
<th>Description</th>
<th>Constraints</th>
</tr>
</thead>
<tbody><tr>
<td><code>query</code></td>
<td>object</td>
<td>Optional</td>
<td></td>
<td><code>additionalProperties: false</code></td>
</tr>
<tr>
<td><code>query.limit</code></td>
<td>integer</td>
<td>Optional</td>
<td>Projects on this page</td>
<td><code>minimum: 1; maximum: 100</code></td>
</tr>
<tr>
<td><code>query.from</code></td>
<td>string</td>
<td>Optional</td>
<td>Copy the continuation token from the preceding project response.</td>
<td><code>minLength: 1; maxLength: 1000</code></td>
</tr>
</tbody></table>
</div>
<p><strong>Full JSON Schema</strong></p>

<p><a href="https://api.tooluse.net/v1/integrations/vercel/commands/vercel.projects.list">Full JSON Schema</a></p>

<p><strong>Example input</strong></p>

<pre><code class="language-json">{
  "query": {
    "limit": 20
  }
}
</code></pre>

<p>At most 1 provider requests per invocation; timeout: 30 seconds.</p>

</details>
<details id="command-vercel-projects-get">
<summary><span>Read project summary — <code>vercel.<wbr>projects.<wbr>get</code></span></summary>
<p>Read one project summary by ID or name within the connection team. Returns identity, framework, Node.js version and timestamps when available. Environment variables, security configuration and embedded deployment settings are excluded.</p>

<p>This is a read operation. Provider rate limits and data access rules still apply.</p>

<p><a href="https://www.tooluse.net/tools/integrations/vercel?command=vercel.projects.get">Connect and use</a></p>

<p><strong>Parameters</strong></p>

<p>Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.</p>

<div class="nb-table-scroll"><table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Required in parent</th>
<th>Description</th>
<th>Constraints</th>
</tr>
</thead>
<tbody><tr>
<td><code>path</code></td>
<td>object</td>
<td>Required</td>
<td></td>
<td><code>additionalProperties: false</code></td>
</tr>
<tr>
<td><code>path.idOrName</code></td>
<td>string</td>
<td>Required</td>
<td>For example prj_... or the exact project name.</td>
<td><code>minLength: 1; maxLength: 100; pattern: &quot;^[A-Za-z0-9_-]{1,100}$&quot;</code></td>
</tr>
</tbody></table>
</div>
<p><strong>Full JSON Schema</strong></p>

<p><a href="https://api.tooluse.net/v1/integrations/vercel/commands/vercel.projects.get">Full JSON Schema</a></p>

<p><strong>Example input</strong></p>

<pre><code class="language-json">{
  "path": {
    "idOrName": "example-project"
  }
}
</code></pre>

<p>At most 1 provider requests per invocation; timeout: 30 seconds.</p>

</details>
<details id="command-vercel-deployments-list">
<summary><span>List deployment metadata — <code>vercel.<wbr>deployments.<wbr>list</code></span></summary>
<p>Read one page of deployment status and metadata, optionally filtered to a project. No deployment, redeployment, build trigger, log streaming or deletion is performed.</p>

<p>This is a read operation. Provider rate limits and data access rules still apply.</p>

<p><a href="https://www.tooluse.net/tools/integrations/vercel?command=vercel.deployments.list">Connect and use</a></p>

<p><strong>Parameters</strong></p>

<p>Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.</p>

<div class="nb-table-scroll"><table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Required in parent</th>
<th>Description</th>
<th>Constraints</th>
</tr>
</thead>
<tbody><tr>
<td><code>query</code></td>
<td>object</td>
<td>Optional</td>
<td></td>
<td><code>additionalProperties: false</code></td>
</tr>
<tr>
<td><code>query.limit</code></td>
<td>integer</td>
<td>Optional</td>
<td>Deployments on this page</td>
<td><code>minimum: 1; maximum: 100</code></td>
</tr>
<tr>
<td><code>query.projectId</code></td>
<td>string</td>
<td>Optional</td>
<td>Optional project ID within the connection team.</td>
<td><code>minLength: 1; maxLength: 100; pattern: &quot;^[A-Za-z0-9_-]{1,100}$&quot;</code></td>
</tr>
<tr>
<td><code>query.until</code></td>
<td>integer</td>
<td>Optional</td>
<td>Use pagination.next from the preceding response, in milliseconds since epoch.</td>
<td><code>minimum: 0; maximum: 9007199254740991</code></td>
</tr>
</tbody></table>
</div>
<p><strong>Full JSON Schema</strong></p>

<p><a href="https://api.tooluse.net/v1/integrations/vercel/commands/vercel.deployments.list">Full JSON Schema</a></p>

<p><strong>Example input</strong></p>

<pre><code class="language-json">{
  "query": {
    "limit": 20,
    "projectId": "prj_example"
  }
}
</code></pre>

<p>At most 1 provider requests per invocation; timeout: 30 seconds.</p>

</details>
<h2>Errors</h2>

<p>Check the key&#39;s expiry, revocation, workspace and allowed operations.</p>

<p>Reuse the same idempotency key only for the same request.</p>

<p>The connection or provider limit has been reached. Check the receipt before retrying.</p>

<h2>Test the connection</h2>

<p>Open the integration&#39;s commands below to inspect parameters and examples. Start with a read command for an account or resource you can access. Refresh your client&#39;s tool list, use the returned tool name, and check the execution result and usage. Provider charges and permissions still apply. Never test a write against production data without reviewing it.</p>

<p><a href="https://vercel.com/docs/rest-api">Official provider documentation</a></p>

Source: https://help.tooluse.net/integrations/vercel/index.mdx