---
title: "CircleCI"
description: "Read CircleCI Cloud organization projects and pipeline identities with your personal API token using API v3. UUIDs and opaque cursors follow the current official API. Each invocation makes one request, without retries, a"
---

> 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.

# CircleCI

<p>Read CircleCI Cloud organization projects and pipeline identities with your personal API token using API v3. UUIDs and opaque cursors follow the current official API. Each invocation makes one request, without retries, automatic paging or polling. This subset excludes pipeline execution, cancellation, configuration, environment variables and logs. CircleCI Server and managed OAuth are not supported by this connection.</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/circleci#command-circleci-projects-list">List organization projects</a> — <code>circleci.projects.list</code></td>
<td>Read</td>
</tr>
<tr>
<td><a href="https://help.tooluse.net/integrations/circleci#command-circleci-pipelines-list">List project pipeline IDs</a> — <code>circleci.pipelines.list</code></td>
<td>Read</td>
</tr>
<tr>
<td><a href="https://help.tooluse.net/integrations/circleci#command-circleci-pipelines-get">Get a pipeline summary</a> — <code>circleci.pipelines.get</code></td>
<td>Read</td>
</tr>
</tbody></table>
</div>
</details>
<h2>Connect and use</h2>

<p><a href="https://www.tooluse.net/tools/integrations/circleci">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 CircleCI, then enter the issued values in the connection form below.</p>
<ol>
<li>In CircleCI User Settings open Personal API Tokens, create a named token with an expiry date, and copy it when shown. Enter it in CircleCI personal API token in this connection. Manually created personal tokens can have broad read/write permissions, so use a dedicated least-privilege account; these Tooluse.net commands only read. Project API tokens and CircleCI Server are not supported by this Cloud v3 connection. Find your organization UUID in Organization Settings, list its projects, then use a project UUID to list pipeline IDs and read a pipeline summary. Include the project UUID for a synthetic OAuth pipeline lookup. Copy project cursors unchanged for the next page. Select only needed commands, save, and create a scoped Tooluse.net API key for your client. Replace an expired or revoked provider token in the same connection; this form does not provide managed OAuth or automatic token refresh.</li>
</ol>
<p><a href="https://circleci.com/docs/guides/toolkit/managing-api-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>CircleCI personal API token</td>
<td>Required</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": {
      "filter[org_id]": "c6e2e2cd-d0ee-4253-be29-d076f9555602",
      "page[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-circleci-projects-list">
<summary><span>List organization projects — <code>circleci.<wbr>projects.<wbr>list</code></span></summary>
<p>Read one explicit page of CircleCI Cloud projects in an organization your personal token can access. Returns project UUIDs, names, following status, organization UUIDs and opaque next/previous cursors. Copy a cursor unchanged into the next call; no automatic paging. Does not read settings, environment variables or trigger builds.</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/circleci?command=circleci.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>Required</td>
<td></td>
<td><code>additionalProperties: false</code></td>
</tr>
<tr>
<td><code>query.filter[org_id]</code></td>
<td>string</td>
<td>Required</td>
<td>Organization UUID from CircleCI Organization Settings; not an organization slug.</td>
<td><code>format: &quot;uuid&quot;</code></td>
</tr>
<tr>
<td><code>query.page[limit]</code></td>
<td>integer</td>
<td>Required</td>
<td>Maximum projects in this page. The official v3 endpoint permits at most 50.</td>
<td><code>minimum: 1; maximum: 50</code></td>
</tr>
<tr>
<td><code>query.page[cursor]</code></td>
<td>string</td>
<td>Optional</td>
<td>Opaque next or previous cursor from an earlier projects result. Omit for the first page; do not decode it or supply a URL.</td>
<td><code>minLength: 1; maxLength: 4096</code></td>
</tr>
</tbody></table>
</div>
<p><strong>Full JSON Schema</strong></p>

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

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

<pre><code class="language-json">{
  "query": {
    "filter[org_id]": "c6e2e2cd-d0ee-4253-be29-d076f9555602",
    "page[limit]": 20
  }
}
</code></pre>

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

</details>
<details id="command-circleci-pipelines-list">
<summary><span>List project pipeline IDs — <code>circleci.<wbr>pipelines.<wbr>list</code></span></summary>
<p>Read pipeline UUIDs for one CircleCI Cloud project. Use a project UUID from projects.list, then pass a returned pipeline UUID to pipelines.get. The official endpoint does not expose pagination parameters; this command makes one request and refuses a response above the existing 512 KiB transport bound. It does not trigger pipelines or return configuration.</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/circleci?command=circleci.pipelines.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>Required</td>
<td></td>
<td><code>additionalProperties: false</code></td>
</tr>
<tr>
<td><code>query.filter[project_id]</code></td>
<td>string</td>
<td>Required</td>
<td>Project UUID from projects.list; project slugs are not accepted by v3.</td>
<td><code>format: &quot;uuid&quot;</code></td>
</tr>
</tbody></table>
</div>
<p><strong>Full JSON Schema</strong></p>

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

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

<pre><code class="language-json">{
  "query": {
    "filter[project_id]": "f4b4e6cc-8568-426b-b750-4d2b57df7f01"
  }
}
</code></pre>

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

</details>
<details id="command-circleci-pipelines-get">
<summary><span>Get a pipeline summary — <code>circleci.<wbr>pipelines.<wbr>get</code></span></summary>
<p>Read the UUID, name, creation time and project UUID of one CircleCI Cloud pipeline. Supply filter[project_id] from the listing request when resolving a synthetic OAuth pipeline; the provider requires its project context. Configuration, checkout details, repository credentials, logs and writes 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/circleci?command=circleci.pipelines.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.id</code></td>
<td>string</td>
<td>Required</td>
<td>Pipeline UUID returned by pipelines.list.</td>
<td><code>format: &quot;uuid&quot;</code></td>
</tr>
<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.filter[project_id]</code></td>
<td>string</td>
<td>Required</td>
<td>Project UUID used for pipelines.list. Required by CircleCI for synthetic OAuth pipeline lookups, optional for stored pipelines.</td>
<td><code>format: &quot;uuid&quot;</code></td>
</tr>
</tbody></table>
</div>
<p><strong>Full JSON Schema</strong></p>

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

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

<pre><code class="language-json">{
  "path": {
    "id": "e7b6b195-e223-4651-98b9-44f734b20f1a"
  },
  "query": {
    "filter[project_id]": "f4b4e6cc-8568-426b-b750-4d2b57df7f01"
  }
}
</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://circleci.com/docs/api/v3/">Official provider documentation</a></p>

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