> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to CircleCI

The CircleCI connector lets your AI agent act in each user's CircleCI account. Each user connects their own CircleCI API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 30 tools.

**Authentication:** API Key
**Categories:** Developer Tools, Automation
**Tools:** 30: 25 read, 5 write, 0 destructive
**Users sign in with:** API key
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=CIRCLECI)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the CircleCI connection

   In **AgentKit > Connections**, create a CircleCI connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'circleci'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize CircleCI:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'circleci_collaborations_list',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "circleci"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize CircleCI:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="circleci_collaborations_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their CircleCI credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'circleci_collaborations_list',
  toolInput: {},
  connector: 'circleci',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="circleci_collaborations_list",
    tool_input={},
    connection_name="circleci",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `circleci_collaborations_list`

List Collaborations · Read-only

List the organizations the connected user is a member of or collaborates on.
Returns each organization's id, name, slug (for example gh/acme), vcs_type and avatar_url.
Use this first to find the org slug or organization id that the pipeline, context and insights tools need.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `circleci_context_envvars_list`

List Context Environment Variables · Read-only

List the environment variables stored in a CircleCI context, without their values.
Returns each variable's variable (name), context_id, created_at and updated_at, plus next_page_token. Secret values are never returned.
Use this to check which variables a context provides to jobs.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `context_id` (`string`, required): UUID of the context, from the id field returned by circleci_contexts_list. Example: 0d4fbe39-e6a0-4b5b-9a8f-3d1a4f1c2e77
- `page_token` (`string`, optional): Pagination token from the next_page_token field of the previous response. Leave empty for the first page. Example: AARLwwV5WgM1TjFGmBJuDWeBbZt7

Example input: `{"context_id":"<context_id>"}`

### `circleci_context_get`

Get Context · Read-only

Get a CircleCI context by its UUID.
Returns the context's id, name and created_at.
Use this to check a context's name. Use circleci_context_envvars_list to see which variables it holds.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `context_id` (`string`, required): UUID of the context, from the id field returned by circleci_contexts_list. Example: 0d4fbe39-e6a0-4b5b-9a8f-3d1a4f1c2e77

Example input: `{"context_id":"<context_id>"}`

### `circleci_contexts_list`

List Contexts · Read-only

List the contexts (shared sets of environment variables) that belong to a CircleCI organization.
Returns each context's id, name and created_at, plus next_page_token.
Use this to find a context id for circleci_context_get or circleci_context_envvars_list. Provide owner_id or owner_slug.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `owner_id` (`string`, optional): UUID of the organization that owns the contexts, from the id field of circleci_collaborations_list or Organization Settings > Overview. Provide this or owner_slug. Example: c9a2d8e4-5f1b-4a7c-8e3d-2b6f9a0c1d4e
- `owner_slug` (`string`, optional): Organization slug, for example gh/acme, from the slug field of circleci_collaborations_list. Provide this or owner_id. Example: gh/acme
- `owner_type` (`string`, optional): Type of the owner: organization (the default, for CircleCI cloud) or account (for CircleCI server installations). Example: organization. One of: `organization`, `account`.
- `page_token` (`string`, optional): Pagination token from the next_page_token field of the previous response. Leave empty for the first page. Example: AARLwwV5WgM1TjFGmBJuDWeBbZt7

Example input: `{}`

### `circleci_insights_flaky_tests_list`

List Flaky Tests · Read-only

List the flaky tests CircleCI detected in a project, across all branches. A flaky test passed and failed on the same commit.
Returns flaky_tests with test_name, classname, file, job_name, workflow_name, times_flaked, pipeline_number and time_wasted, plus total_flaky_tests.
Use this to find unreliable tests. Use circleci_job_tests_list for the results of one job.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_slug` (`string`, required): Project slug in the form vcs-slug/org-name/repo-name, copied from Project Settings > Overview in CircleCI. GitHub OAuth projects use gh/<org>/<repo> and Bitbucket projects bb/<org>/<repo>; GitHub App and GitLab projects use circleci/<organization-id>/<project-id>. Example: gh/acme/web-app

Example input: `{"project_slug":"<project_slug>"}`

### `circleci_insights_org_summary_get`

Get Organization Insights Summary · Read-only

Get summary metrics with trends for a whole CircleCI organization and for each of its projects.
Returns org_data (metrics and trends for total_runs, total_duration_secs, total_credits_used, success_rate, throughput), org_project_data per project, and all_projects.
Use this for an organization-wide health overview. Use circleci_insights_workflows_list to drill into one project.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `org_slug` (`string`, required): Organization slug in the form vcs-slug/org-name, from the slug field of circleci_collaborations_list. Example: gh/acme
- `reporting_window` (`string`, optional): Time window used to calculate the summary metrics. CircleCI uses last-90-days when omitted. One of last-24-hours, last-7-days, last-30-days, last-60-days, last-90-days. Example: last-30-days. One of: `last-24-hours`, `last-7-days`, `last-30-days`, `last-60-days`, `last-90-days`.

Example input: `{"org_slug":"<org_slug>"}`

### `circleci_insights_test_metrics_get`

Get Workflow Test Metrics · Read-only

Get test metrics for one workflow of a CircleCI project, calculated from its 10 most recent runs.
Returns average_test_count, total_test_runs, most_failed_tests, slowest_tests (with failed_runs, p95_duration, flaky flag) and test_runs.
Use this to find the most failed and slowest tests in a workflow. Use circleci_insights_flaky_tests_list for flaky tests across the project.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_slug` (`string`, required): Project slug in the form vcs-slug/org-name/repo-name, copied from Project Settings > Overview in CircleCI. GitHub OAuth projects use gh/<org>/<repo> and Bitbucket projects bb/<org>/<repo>; GitHub App and GitLab projects use circleci/<organization-id>/<project-id>. Example: gh/acme/web-app
- `workflow_name` (`string`, required): Name of the workflow as defined in the project's .circleci/config.yml, for example build-and-test. Use circleci_insights_workflows_list to see the names that have run. Example: build-and-test
- `all_branches` (`boolean`, optional): Set to true to aggregate data across all branches instead of a single branch. Use either this or branch, not both. Example: true
- `branch` (`string`, optional): Name of a VCS branch to limit results to. Defaults to the project's default branch. Do not combine with all_branches. Example: main

Example input: `{"project_slug":"<project_slug>","workflow_name":"<workflow_name>"}`

### `circleci_insights_workflow_jobs_list`

List Workflow Job Insights · Read-only

Get summary metrics for each job of one workflow in a CircleCI project over a reporting window.
Returns per job: name, metrics (total_runs, successful_runs, failed_runs, success_rate, throughput, total_credits_used, duration_metrics) and window_start/window_end, plus next_page_token. Metrics cover up to 90 days, are refreshed daily and may miss the last 24 hours; they are not a billing source.
Use this to find the slowest or least reliable jobs in a workflow.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_slug` (`string`, required): Project slug in the form vcs-slug/org-name/repo-name, copied from Project Settings > Overview in CircleCI. GitHub OAuth projects use gh/<org>/<repo> and Bitbucket projects bb/<org>/<repo>; GitHub App and GitLab projects use circleci/<organization-id>/<project-id>. Example: gh/acme/web-app
- `workflow_name` (`string`, required): Name of the workflow as defined in the project's .circleci/config.yml, for example build-and-test. Use circleci_insights_workflows_list to see the names that have run. Example: build-and-test
- `all_branches` (`boolean`, optional): Set to true to aggregate data across all branches instead of a single branch. Use either this or branch, not both. Example: true
- `branch` (`string`, optional): Name of a VCS branch to limit results to. Defaults to the project's default branch. Do not combine with all_branches. Example: main
- `job_name` (`string`, optional): Full job name, or a substring of it, to limit the results to matching jobs. Leave empty for every job. Example: test
- `page_token` (`string`, optional): Pagination token from the next_page_token field of the previous response. Leave empty for the first page. Example: AARLwwV5WgM1TjFGmBJuDWeBbZt7
- `reporting_window` (`string`, optional): Time window used to calculate the summary metrics. CircleCI uses last-90-days when omitted. One of last-24-hours, last-7-days, last-30-days, last-60-days, last-90-days. Example: last-30-days. One of: `last-24-hours`, `last-7-days`, `last-30-days`, `last-60-days`, `last-90-days`.

Example input: `{"project_slug":"<project_slug>","workflow_name":"<workflow_name>"}`

### `circleci_insights_workflow_runs_list`

List Workflow Runs · Read-only

List recent runs of one workflow in a CircleCI project, optionally within a date range.
Returns each run's id, branch, status, duration, created_at, stopped_at and credits_used, plus next_page_token. Runs go back at most 90 days.
Use this to see a workflow's run history. Use circleci_insights_workflows_list for aggregated metrics instead.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_slug` (`string`, required): Project slug in the form vcs-slug/org-name/repo-name, copied from Project Settings > Overview in CircleCI. GitHub OAuth projects use gh/<org>/<repo> and Bitbucket projects bb/<org>/<repo>; GitHub App and GitLab projects use circleci/<organization-id>/<project-id>. Example: gh/acme/web-app
- `workflow_name` (`string`, required): Name of the workflow as defined in the project's .circleci/config.yml, for example build-and-test. Use circleci_insights_workflows_list to see the names that have run. Example: build-and-test
- `all_branches` (`boolean`, optional): Set to true to aggregate data across all branches instead of a single branch. Use either this or branch, not both. Example: true
- `branch` (`string`, optional): Name of a VCS branch to limit results to. Defaults to the project's default branch. Do not combine with all_branches. Example: main
- `end_date` (`string`, optional): Include only runs that started before this time, as an ISO 8601 date-time, at most 90 days after start_date. Example: 2026-10-31T00:00:00Z
- `page_token` (`string`, optional): Pagination token from the next_page_token field of the previous response. Leave empty for the first page. Example: AARLwwV5WgM1TjFGmBJuDWeBbZt7
- `start_date` (`string`, optional): Include only runs that started at or after this time, as an ISO 8601 date-time. Required when end_date is set. Example: 2026-10-01T00:00:00Z

Example input: `{"project_slug":"<project_slug>","workflow_name":"<workflow_name>"}`

### `circleci_insights_workflows_list`

List Workflow Insights · Read-only

Get summary metrics for each workflow of a CircleCI project over a reporting window.
Returns per workflow: name, metrics (total_runs, successful_runs, failed_runs, success_rate, throughput, mttr, total_credits_used, duration_metrics) and window_start/window_end, plus next_page_token. Metrics cover up to 90 days, are refreshed daily and may miss the last 24 hours; they are not a billing source.
Use this to compare workflows or find the workflow names the other insights tools take.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_slug` (`string`, required): Project slug in the form vcs-slug/org-name/repo-name, copied from Project Settings > Overview in CircleCI. GitHub OAuth projects use gh/<org>/<repo> and Bitbucket projects bb/<org>/<repo>; GitHub App and GitLab projects use circleci/<organization-id>/<project-id>. Example: gh/acme/web-app
- `all_branches` (`boolean`, optional): Set to true to aggregate data across all branches instead of a single branch. Use either this or branch, not both. Example: true
- `branch` (`string`, optional): Name of a VCS branch to limit results to. Defaults to the project's default branch. Do not combine with all_branches. Example: main
- `page_token` (`string`, optional): Pagination token from the next_page_token field of the previous response. Leave empty for the first page. Example: AARLwwV5WgM1TjFGmBJuDWeBbZt7
- `reporting_window` (`string`, optional): Time window used to calculate the summary metrics. CircleCI uses last-90-days when omitted. One of last-24-hours, last-7-days, last-30-days, last-60-days, last-90-days. Example: last-30-days. One of: `last-24-hours`, `last-7-days`, `last-30-days`, `last-60-days`, `last-90-days`.

Example input: `{"project_slug":"<project_slug>"}`

### `circleci_job_artifacts_list`

List Job Artifacts · Read-only

List the artifacts a CircleCI job stored with store_artifacts.
Returns each artifact's path, node_index and download url, plus next_page_token. Downloading a url needs the same Circle-Token for private projects.
Use this to find build outputs, coverage reports or logs a job saved.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `job_number` (`integer`, required): Job number within the project, from the job_number field returned by circleci_workflow_jobs_list (also shown in the job's URL in the CircleCI app). Example: 1234
- `project_slug` (`string`, required): Project slug in the form vcs-slug/org-name/repo-name, copied from Project Settings > Overview in CircleCI. GitHub OAuth projects use gh/<org>/<repo> and Bitbucket projects bb/<org>/<repo>; GitHub App and GitLab projects use circleci/<organization-id>/<project-id>. Example: gh/acme/web-app
- `page_token` (`string`, optional): Pagination token from the next_page_token field of the previous response. Leave empty for the first page. Example: AARLwwV5WgM1TjFGmBJuDWeBbZt7

Example input: `{"job_number":1234,"project_slug":"<project_slug>"}`

### `circleci_job_get`

Get Job · Read-only

Get the details of a CircleCI job by project slug and job number.
Returns the job's name, number, status, started_at, stopped_at, duration, executor, parallelism, parallel_runs, messages, contexts, latest_workflow, pipeline and web_url.
Use this to see why a job failed or how long it took. Use circleci_job_tests_list for its test results and circleci_job_artifacts_list for its files.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `job_number` (`integer`, required): Job number within the project, from the job_number field returned by circleci_workflow_jobs_list (also shown in the job's URL in the CircleCI app). Example: 1234
- `project_slug` (`string`, required): Project slug in the form vcs-slug/org-name/repo-name, copied from Project Settings > Overview in CircleCI. GitHub OAuth projects use gh/<org>/<repo> and Bitbucket projects bb/<org>/<repo>; GitHub App and GitLab projects use circleci/<organization-id>/<project-id>. Example: gh/acme/web-app

Example input: `{"job_number":1234,"project_slug":"<project_slug>"}`

### `circleci_job_tests_list`

List Job Test Results · Read-only

List the test results a CircleCI job uploaded with store_test_results.
Returns each test's name, classname, file, result (success, failure, skipped), message (failure output), run_time and source, plus next_page_token.
Use this to see which tests failed in one job. Use circleci_insights_flaky_tests_list or circleci_insights_test_metrics_get for trends across runs.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `job_number` (`integer`, required): Job number within the project, from the job_number field returned by circleci_workflow_jobs_list (also shown in the job's URL in the CircleCI app). Example: 1234
- `project_slug` (`string`, required): Project slug in the form vcs-slug/org-name/repo-name, copied from Project Settings > Overview in CircleCI. GitHub OAuth projects use gh/<org>/<repo> and Bitbucket projects bb/<org>/<repo>; GitHub App and GitLab projects use circleci/<organization-id>/<project-id>. Example: gh/acme/web-app
- `page_token` (`string`, optional): Pagination token from the next_page_token field of the previous response. Leave empty for the first page. Example: AARLwwV5WgM1TjFGmBJuDWeBbZt7

Example input: `{"job_number":1234,"project_slug":"<project_slug>"}`

### `circleci_me_get`

Get Current User · Read-only

Get the CircleCI user that owns the connected personal API token.
Returns the user's id, login and name.
Use this to confirm which account the connection acts as. Use circleci_collaborations_list to find the organizations that user can reach.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `circleci_pipeline_config_get`

Get Pipeline Configuration · Read-only

Get the configuration a CircleCI pipeline ran with.
Returns source (the config.yml as committed), compiled (the processed config after orbs and parameters are expanded), and setup-config and compiled-setup-config for dynamic config.
Use this to see exactly which jobs and steps a pipeline ran, for example when debugging a config change.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `pipeline_id` (`string`, required): UUID of the pipeline, from the id field returned by circleci_pipelines_list, circleci_project_pipelines_list or circleci_pipeline_trigger. Example: 5034460f-c7c4-4c43-9457-de07e2029e7b

Example input: `{"pipeline_id":"<pipeline_id>"}`

### `circleci_pipeline_get`

Get Pipeline · Read-only

Get a CircleCI pipeline by its UUID.
Returns the pipeline's id, number, project_slug, state, created_at, updated_at, errors, trigger, trigger_parameters and vcs details.
Use this when you have a pipeline id. Use circleci_pipeline_get_by_number when you have the project slug and pipeline number from the CircleCI app.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `pipeline_id` (`string`, required): UUID of the pipeline, from the id field returned by circleci_pipelines_list, circleci_project_pipelines_list or circleci_pipeline_trigger. Example: 5034460f-c7c4-4c43-9457-de07e2029e7b

Example input: `{"pipeline_id":"<pipeline_id>"}`

### `circleci_pipeline_get_by_number`

Get Pipeline by Number · Read-only

Get a pipeline of a CircleCI project by its pipeline number.
Returns the pipeline's id, number, state, created_at, errors, trigger and vcs details.
Use this when you have the number shown in the CircleCI app or a pipeline URL. Use circleci_pipeline_get when you have the pipeline id.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `pipeline_number` (`integer`, required): Pipeline number within the project, from the number field of a pipeline or from the pipeline URL in the CircleCI app. Example: 482
- `project_slug` (`string`, required): Project slug in the form vcs-slug/org-name/repo-name, copied from Project Settings > Overview in CircleCI. GitHub OAuth projects use gh/<org>/<repo> and Bitbucket projects bb/<org>/<repo>; GitHub App and GitLab projects use circleci/<organization-id>/<project-id>. Example: gh/acme/web-app

Example input: `{"pipeline_number":482,"project_slug":"<project_slug>"}`

### `circleci_pipeline_workflows_list`

List Pipeline Workflows · Read-only

List the workflows of a CircleCI pipeline.
Returns each workflow's id, name, status (success, running, failed, on_hold, canceled and others), created_at, stopped_at, pipeline_number and project_slug, plus next_page_token.
Use this after finding a pipeline to get the workflow ids that the workflow and job tools need.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `pipeline_id` (`string`, required): UUID of the pipeline, from the id field returned by circleci_pipelines_list, circleci_project_pipelines_list or circleci_pipeline_trigger. Example: 5034460f-c7c4-4c43-9457-de07e2029e7b
- `page_token` (`string`, optional): Pagination token from the next_page_token field of the previous response. Leave empty for the first page. Example: AARLwwV5WgM1TjFGmBJuDWeBbZt7

Example input: `{"pipeline_id":"<pipeline_id>"}`

### `circleci_pipelines_list`

List Pipelines in Organization · Read-only

List recent pipelines across the projects the connected user follows in an organization (up to 250 of the most recently built projects).
Returns pipelines newest first with id, number, project_slug, state, created_at, trigger (type, actor) and vcs details (branch, revision, commit subject), plus next_page_token.
Use this for an organization-wide view. Use circleci_project_pipelines_list for one project or one branch.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `mine` (`boolean`, optional): Set to true to include only pipelines triggered by the connected user. Example: true
- `org_slug` (`string`, optional): Organization slug in the form vcs-slug/org-name, from the slug field of circleci_collaborations_list. GitHub App and GitLab organizations use circleci/<organization-id>. Example: gh/acme
- `page_token` (`string`, optional): Pagination token from the next_page_token field of the previous response. Leave empty for the first page. Example: AARLwwV5WgM1TjFGmBJuDWeBbZt7

Example input: `{}`

### `circleci_project_envvar_get`

Get Project Environment Variable · Read-only

Get one environment variable of a CircleCI project by name, with its value masked.
Returns the variable's name, masked value (four x characters plus the last four characters) and created_at; the secret value is never returned.
Use this to confirm that a specific variable exists. Use circleci_project_envvars_list to see every variable.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `name` (`string`, required): Name of the environment variable, exactly as set in Project Settings > Environment Variables. Example: AWS_ACCESS_KEY_ID
- `project_slug` (`string`, required): Project slug in the form vcs-slug/org-name/repo-name, copied from Project Settings > Overview in CircleCI. GitHub OAuth projects use gh/<org>/<repo> and Bitbucket projects bb/<org>/<repo>; GitHub App and GitLab projects use circleci/<organization-id>/<project-id>. Example: gh/acme/web-app

Example input: `{"name":"<name>","project_slug":"<project_slug>"}`

### `circleci_project_envvars_list`

List Project Environment Variables · Read-only

List the environment variables set on a CircleCI project, with values masked.
Returns each variable's name, masked value (four x characters plus the last four characters of the value) and created_at; secret values are never returned.
Use this to see which variables a project defines. Use circleci_project_envvar_get to check one variable by name.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_slug` (`string`, required): Project slug in the form vcs-slug/org-name/repo-name, copied from Project Settings > Overview in CircleCI. GitHub OAuth projects use gh/<org>/<repo> and Bitbucket projects bb/<org>/<repo>; GitHub App and GitLab projects use circleci/<organization-id>/<project-id>. Example: gh/acme/web-app
- `page_token` (`string`, optional): Pagination token from the next_page_token field of the previous response. Leave empty for the first page. Example: AARLwwV5WgM1TjFGmBJuDWeBbZt7

Example input: `{"project_slug":"<project_slug>"}`

### `circleci_project_get`

Get Project · Read-only

Get a CircleCI project by its project slug.
Returns the project's id, slug, name, organization_name, organization_slug, organization_id and vcs_info (VCS URL, provider and default branch).
Use this to check a project slug or find a project's id and default branch.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_slug` (`string`, required): Project slug in the form vcs-slug/org-name/repo-name, copied from Project Settings > Overview in CircleCI. GitHub OAuth projects use gh/<org>/<repo> and Bitbucket projects bb/<org>/<repo>; GitHub App and GitLab projects use circleci/<organization-id>/<project-id>. Example: gh/acme/web-app

Example input: `{"project_slug":"<project_slug>"}`

### `circleci_project_pipelines_list`

List Project Pipelines · Read-only

List the pipelines of one CircleCI project, optionally limited to a branch.
Returns pipelines newest first with id, number, state, created_at, trigger (type, actor), errors and vcs details (branch, revision, commit subject), plus next_page_token.
Use this to find the latest pipeline on a branch. Use circleci_pipelines_list for every project in an organization.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_slug` (`string`, required): Project slug in the form vcs-slug/org-name/repo-name, copied from Project Settings > Overview in CircleCI. GitHub OAuth projects use gh/<org>/<repo> and Bitbucket projects bb/<org>/<repo>; GitHub App and GitLab projects use circleci/<organization-id>/<project-id>. Example: gh/acme/web-app
- `branch` (`string`, optional): Name of a VCS branch to list pipelines for. Leave empty for all branches. Example: main
- `page_token` (`string`, optional): Pagination token from the next_page_token field of the previous response. Leave empty for the first page. Example: AARLwwV5WgM1TjFGmBJuDWeBbZt7

Example input: `{"project_slug":"<project_slug>"}`

### `circleci_workflow_get`

Get Workflow · Read-only

Get a CircleCI workflow by its UUID.
Returns the workflow's id, name, status, created_at, stopped_at, pipeline_id, pipeline_number, project_slug, started_by and canceled_by.
Use this to check whether a workflow passed, failed or is still running. Use circleci_workflow_jobs_list to see its jobs.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `workflow_id` (`string`, required): UUID of the workflow, from the id field returned by circleci_pipeline_workflows_list. Example: 9c40e8cf-6d47-4b8f-9a2b-7e1f3c0f5a21

Example input: `{"workflow_id":"<workflow_id>"}`

### `circleci_workflow_jobs_list`

List Workflow Jobs · Read-only

List the jobs of a CircleCI workflow.
Returns each job's id, name, job_number, type (build or approval), status, started_at, stopped_at, dependencies and approval_request_id, plus next_page_token.
Use this to find failed jobs and their job numbers before calling circleci_job_get, circleci_job_artifacts_list or circleci_job_tests_list, or to find the approval_request_id for circleci_workflow_approve.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `workflow_id` (`string`, required): UUID of the workflow, from the id field returned by circleci_pipeline_workflows_list. Example: 9c40e8cf-6d47-4b8f-9a2b-7e1f3c0f5a21
- `page_token` (`string`, optional): Pagination token from the next_page_token field of the previous response. Leave empty for the first page. Example: AARLwwV5WgM1TjFGmBJuDWeBbZt7

Example input: `{"workflow_id":"<workflow_id>"}`

### `circleci_job_cancel`

Cancel Job · Write

Cancel a running or queued CircleCI job by project slug and job number.
Returns a message confirming the job was canceled.
Use this to stop one job. Use circleci_workflow_cancel to stop a whole workflow.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `job_number` (`integer`, required): Job number within the project, from the job_number field returned by circleci_workflow_jobs_list (also shown in the job's URL in the CircleCI app). Example: 1234
- `project_slug` (`string`, required): Project slug in the form vcs-slug/org-name/repo-name, copied from Project Settings > Overview in CircleCI. GitHub OAuth projects use gh/<org>/<repo> and Bitbucket projects bb/<org>/<repo>; GitHub App and GitLab projects use circleci/<organization-id>/<project-id>. Example: gh/acme/web-app

Example input: `{"job_number":1234,"project_slug":"<project_slug>"}`

### `circleci_pipeline_trigger`

Trigger Pipeline · Write

Trigger a new pipeline run for a CircleCI project, optionally on a specific branch or tag and with pipeline parameters.
Returns the new pipeline's id, number, state and created_at.
Use this to start a build or deploy. Use circleci_workflow_rerun to rerun an existing workflow instead.
Supported for GitHub (OAuth, App or Server) and Bitbucket Cloud projects; GitLab projects are not supported by this endpoint.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `organization` (`string`, required): Second segment of the project slug: the organization name (for example acme) or, for GitHub App projects, the organization id. Example: acme
- `project` (`string`, required): Third segment of the project slug: the repository name (for example web-app) or, for GitHub App projects, the project id. Example: web-app
- `provider` (`string`, required): First segment of the project slug shown in Project Settings > Overview: gh or github for GitHub OAuth, bb or bitbucket for Bitbucket, circleci for GitHub App projects. Example: gh. One of: `gh`, `github`, `bb`, `bitbucket`, `circleci`.
- `checkout_branch` (`string`, optional): Branch to check out in checkout steps. Do not combine with checkout_tag. For a GitHub pull request use pull/<number>/head or pull/<number>/merge. Example: main
- `checkout_tag` (`string`, optional): Tag to check out in checkout steps. Do not combine with checkout_branch. Example: v2.4.0
- `config_branch` (`string`, optional): Branch to read the config file from. Do not combine with config_tag. For a GitHub pull request use pull/<number>/head or pull/<number>/merge. Example: main
- `config_tag` (`string`, optional): Tag to read the config file from. Do not combine with config_branch. Example: v2.4.0
- `definition_id` (`string`, optional): UUID of the pipeline definition to run, from Project Settings > Pipelines. Needed when the project has more than one pipeline definition. Example: 2338d0ae-5541-4bbf-88a2-55e9f7281f80
- `parameters` (`object`, optional): Pipeline parameters declared in the config, as an object of parameter names to string, number or boolean values. Up to 100 entries; keys up to 128 characters and values up to 512. Example: {"deploy_prod": true, "region": "us-east-1"}

Example input: `{"organization":"<organization>","project":"<project>","provider":"gh"}`

### `circleci_workflow_approve`

Approve Workflow Job · Write

Approve a pending approval job (hold step) in a CircleCI workflow so the jobs after it can run.
Returns a message confirming the approval was accepted.
Use this when a workflow is on_hold. Get the approval_request_id from circleci_workflow_jobs_list (the job with type approval).

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `approval_request_id` (`string`, required): UUID of the approval job, from the approval_request_id field of the approval-type job returned by circleci_workflow_jobs_list. Example: 2e9d1f7a-4b3c-4d8e-9f01-6a7b8c9d0e1f
- `workflow_id` (`string`, required): UUID of the workflow, from the id field returned by circleci_pipeline_workflows_list. Example: 9c40e8cf-6d47-4b8f-9a2b-7e1f3c0f5a21

Example input: `{"approval_request_id":"<approval_request_id>","workflow_id":"<workflow_id>"}`

### `circleci_workflow_cancel`

Cancel Workflow · Write

Cancel a running CircleCI workflow, stopping all of its running and queued jobs.
Returns a message confirming the request was accepted.
Use this to stop a whole workflow. Use circleci_job_cancel to stop a single job.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `workflow_id` (`string`, required): UUID of the workflow, from the id field returned by circleci_pipeline_workflows_list. Example: 9c40e8cf-6d47-4b8f-9a2b-7e1f3c0f5a21

Example input: `{"workflow_id":"<workflow_id>"}`

### `circleci_workflow_rerun`

Rerun Workflow · Write

Rerun a CircleCI workflow, either in full, from its failed jobs, or for selected jobs.
Returns the workflow_id of the new workflow run.
Use this to retry a failed or flaky workflow. Use circleci_pipeline_trigger to start a new pipeline from a branch instead.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `workflow_id` (`string`, required): UUID of the workflow, from the id field returned by circleci_pipeline_workflows_list. Example: 9c40e8cf-6d47-4b8f-9a2b-7e1f3c0f5a21
- `enable_ssh` (`boolean`, optional): Set to true to rerun the selected jobs with SSH access for the connected user. Requires jobs. Example: true
- `from_failed` (`boolean`, optional): Set to true to rerun only the failed jobs and everything downstream of them. Do not combine with jobs. Example: true
- `jobs` (`array`, optional): Job UUIDs to rerun (the id field from circleci_workflow_jobs_list, not the job number). Do not combine with from_failed. Example: ["c65b68ef-e73b-4bf2-be9a-7a322a9df150"]
- `sparse_tree` (`boolean`, optional): Set to true to rerun only the selected jobs and the jobs connected to them, an optimisation for workflows with disconnected subgraphs. Requires jobs. Example: true

Example input: `{"workflow_id":"<workflow_id>"}`

## Related

Other Developer Tools connectors ([all 200](/agentkit/connectors/?category=developer-tools)):

- [GitHub](/agentkit/connectors/github/): Scalekit connector, OAuth, 217 tools
- [Datadog](/agentkit/connectors/datadog/): Scalekit connector, API key, 105 tools
- [Linear](/agentkit/connectors/linear/): Scalekit connector, OAuth, 64 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
