# CircleCI

CircleCI is a continuous integration and delivery platform that automates build, test, and deployment pipelines for software development.

- **Category:** developer tools
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 65
- **Triggers:** 0
- **Slug:** `CIRCLECI`
- **Version:** 20260312_00

## Tools

### Create Context

**Slug:** `CIRCLECI_CREATE_CONTEXT`

Tool to create a new context in CircleCI. Contexts are used to secure and share environment variables across projects. Use this when you need to set up a new environment configuration for your CircleCI workflows.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The user-defined name of the context. This name must be unique within the owner scope. |
| `owner` | object | Yes | Owner information specifying who owns this context (organization or account). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Context (GraphQL)

**Slug:** `CIRCLECI_CREATE_CONTEXT_GRAPHQL`

Tool to create a new CircleCI context using the GraphQL API. Use when you need to create a context for storing environment variables in CircleCI. The mutation returns error information if creation fails or payload data if successful.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `owner_id` | string | Yes | The unique ID of the owner organization (UUID format). |
| `owner_type` | string ("ORGANIZATION") | Yes | The type of owner - must be ORGANIZATION. |
| `context_name` | string | Yes | The name of the context to create. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Context Restriction

**Slug:** `CIRCLECI_CREATE_CONTEXT_RESTRICTION`

Tool to create a context restriction in CircleCI. Use when you need to limit context access based on project, expression rules, or group membership.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `context_id` | string | Yes | An opaque identifier of a context. |
| `restriction_type` | string ("project" | "expression" | "group") | Yes | Type of the restriction. Use 'project' to restrict by project UUID, 'expression' to restrict by expression rule (e.g., branch conditions), or 'group' to restrict by group. |
| `restriction_value` | string | Yes | Value used to evaluate the restriction. If the restriction_type is 'project', this will be the project UUID. If the restriction_type is 'expression', this will be the expression rule (e.g., 'pipeline.git.branch == "main"'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Organization Orb Allowlist

**Slug:** `CIRCLECI_CREATE_ORGANIZATION_ORB_ALLOWLIST`

Tool to create a new URL Orb allow-list entry for an organization. Use when you need to allow URL-based orb references from specific URL prefixes in CircleCI pipelines for an organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `auth` | string ("github-oauth" | "none" | "bitbucket-oauth" | "github-app") | Yes | An authentication method to use for fetching URL orb references that match this allow-list entry's prefix. |
| `name` | string | Yes | Name of the URL orb allow-list entry. |
| `prefix` | string | Yes | URL prefix. URL orb references that start with this prefix will be allowed by this allow-list entry. |
| `org_slug_or_id` | string | Yes | Org UUID or slug in the form `vcs-slug/org-name`. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug` and replace the `org-name` with the organization ID (found in Organization Settings). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Organization Project

**Slug:** `CIRCLECI_CREATE_ORGANIZATION_PROJECT`

Tool to create a new project within a CircleCI organization. Use when you need to programmatically set up a new project for CI/CD automation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the project to create. |
| `org_slug_or_id` | string | Yes | Org UUID or slug in the form `vcs-slug/org-name`. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug` and replace the `org-name` with the organization ID (found in Organization Settings). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Organization Group

**Slug:** `CIRCLECI_CREATE_ORG_GROUP`

Tool to create a group in an organization. Use when you need to organize users within a CircleCI organization by creating logical groups.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the group. |
| `org_id` | string | Yes | An opaque identifier of an organization. |
| `description` | string | No | Description to describe the group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Project Environment Variable

**Slug:** `CIRCLECI_CREATE_PROJECT_ENV_VAR`

Tool to create a new environment variable for a CircleCI project. Use when you need to add a new environment variable that will be available in project builds.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the environment variable to create. |
| `value` | string | Yes | The value of the environment variable. |
| `project_slug` | string | Yes | Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Usage Export Job

**Slug:** `CIRCLECI_CREATE_USAGE_EXPORT_JOB`

Tool to create a usage export job for a CircleCI organization. Use when you need to export usage data for billing, analysis, or reporting purposes. Rate limited to 10 queries per hour. Maximum date window is 32 days, with up to 13 months of historical data available.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | Yes | End date for the usage export in ISO 8601 format (e.g., '2026-02-07T23:59:59Z'). Maximum date window is 32 days between start and end. |
| `start` | string | Yes | Start date for the usage export in ISO 8601 format (e.g., '2026-02-01T00:00:00Z'). Maximum date window is 32 days between start and end. |
| `org_id` | string | Yes | Organization ID (UUID) to create the usage export for. |
| `shared_org_ids` | array | No | Array of organization IDs to include in shared context. Use this to include usage data from related organizations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Context (GraphQL)

**Slug:** `CIRCLECI_DELETE_CONTEXT_GRAPHQL`

Tool to delete a CircleCI context by its UUID using GraphQL API. Use when you need to permanently remove a context from your CircleCI organization. This action is irreversible and will delete all environment variables associated with the context.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `context_id` | string | Yes | The UUID of the context to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Context Restriction

**Slug:** `CIRCLECI_DELETE_CONTEXT_RESTRICTION`

Tool to delete a context restriction by its ID. Use when you need to remove a specific restriction from a CircleCI context.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `context_id` | string | Yes | An opaque identifier of a context. |
| `restriction_id` | string | Yes | An opaque identifier of a context restriction. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Namespace and Related Orbs

**Slug:** `CIRCLECI_DELETE_NAMESPACE`

Tool to delete a CircleCI registry namespace and all its associated orbs. Use when you need to permanently remove a namespace from the registry. This is a destructive operation that cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `namespace_id` | string | Yes | The UUID identifier of the namespace to delete. This will delete the namespace and all associated orbs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Namespace Alias

**Slug:** `CIRCLECI_DELETE_NAMESPACE_ALIAS`

Tool to remove a namespace alias by name in CircleCI. Use when you need to delete an existing namespace alias that is no longer needed. The mutation returns a boolean indicating success and any errors that occurred during deletion.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the namespace alias to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Organization Orb Allowlist Entry

**Slug:** `CIRCLECI_DELETE_ORGANIZATION_ORB_ALLOWLIST`

Tool to remove an entry from the organization's URL orb allow-list. Use when you need to revoke access to a previously allowed orb URL.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_slug_or_id` | string | Yes | Org UUID or slug in the form `vcs-slug/org-name`. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug` and replace the `org-name` with the organization ID (found in Organization Settings). |
| `allow_list_entry_id` | string | Yes | URL orb allow-list entry UUID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Organization Group

**Slug:** `CIRCLECI_DELETE_ORG_GROUP`

Tool to delete a group from a CircleCI organization. Use when you need to remove a group permanently from the organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | An opaque identifier of an organization. |
| `group_id` | string | Yes | An opaque identifier of a group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Project

**Slug:** `CIRCLECI_DELETE_PROJECT`

Tool to delete a CircleCI project and its settings. Use when you need to permanently remove a project from CircleCI. This action cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_slug` | string | Yes | Project slug in the form 'vcs-slug/org-name/repo-name'. The '/' characters may be URL-escaped. For projects that use GitLab or GitHub App, use 'circleci' as the 'vcs-slug', replace 'org-name' with the organization ID (found in Organization Settings), and replace 'repo-name' with the project ID (found in Project Settings). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Project Environment Variable

**Slug:** `CIRCLECI_DELETE_PROJECT_ENV_VAR`

Tool to delete an environment variable from a CircleCI project. Use when you need to remove an existing environment variable by name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the environment variable to delete. |
| `project_slug` | string | Yes | Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Context

**Slug:** `CIRCLECI_GET_CONTEXT`

Tool to retrieve a context by its unique ID. Use when you need details about a specific CircleCI context.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `context_id` | string | Yes | An opaque identifier of a context. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Current User

**Slug:** `CIRCLECI_GET_CURRENT_USER`

Tool to retrieve information about the currently authenticated user. Use when you need details about the signed-in user's profile, permissions, and account settings.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Flaky Tests

**Slug:** `CIRCLECI_GET_FLAKY_TESTS`

Tool to get flaky tests for a project. Use when you need to identify tests that passed and failed in the same commit. Branch-agnostic insights help improve test reliability.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_slug` | string | Yes | The project slug in the form 'vcs-slug/org-name/repo-name' (e.g., 'gh/CircleCI-Public/circleci-cli'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Job Artifacts

**Slug:** `CIRCLECI_GET_JOB_ARTIFACTS`

Retrieves artifacts (output files like test results, logs, build binaries, reports) produced by a CircleCI job. Use this when you need to access files generated during a job's execution, such as test reports, coverage data, compiled binaries, or deployment artifacts. Returns download URLs for each artifact. Note: Jobs may produce zero artifacts if none were explicitly stored using 'store_artifacts' in the config.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_number` | integer | Yes | The number of the job to list artifacts for. |
| `page-token` | string | No | Token to retrieve the next page of results. Obtain this from the 'next_page_token' field in a previous response. |
| `project_slug` | string | Yes | The project slug in the form of 'vcs-slug/org-name/repo-name', e.g., 'gh/CircleCI-Public/api-preview-docs'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Job Details

**Slug:** `CIRCLECI_GET_JOB_DETAILS`

Tool to fetch details of a specific job within a project. Use when you need status, timing, and executor information for a CircleCI job by its number.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_number` | integer | Yes | The number of the job to fetch details for. |
| `project_slug` | string | Yes | The project slug in the form 'vcs-slug/org-name/repo-name', e.g., 'gh/CircleCI-Public/api-preview-docs'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Orb Details

**Slug:** `CIRCLECI_GET_ORB_DETAILS`

Tool to query detailed information about a CircleCI orb using the GraphQL API. Use when you need to retrieve orb metadata, versions, usage statistics, or namespace details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The orb reference in format 'namespace/orbname'. Use this to query public orbs like 'circleci/node' or 'circleci/python'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Orb Version

**Slug:** `CIRCLECI_GET_ORB_VERSION`

Tool to retrieve detailed information about a specific CircleCI orb version via GraphQL. Use when you need orb source code, version history, usage statistics, or metadata for a specific orb version.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `orb_version_ref` | string | Yes | The orb reference including version information. Format: 'namespace/orb-name@version' (e.g., 'circleci/node@5.0.0'). The namespace identifies the orb publisher, orb-name is the orb identifier, and version is the specific version to query. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Organization

**Slug:** `CIRCLECI_GET_ORGANIZATION`

Tool to retrieve organization details from CircleCI using GraphQL query. Use when you need organization information by ID or by name and VCS type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | No | The unique UUID of the organization. Either org_id OR both org_name and vcs_type must be provided. |
| `org_name` | string | No | The name of the organization. Must be provided together with vcs_type if org_id is not provided. |
| `vcs_type` | string | No | The version control system type. Must be provided together with org_name if org_id is not provided. Common values: GITHUB, BITBUCKET. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Organization Group

**Slug:** `CIRCLECI_GET_ORGANIZATION_GROUP`

Tool to retrieve a group in an organization. Use when you need to get details about a specific group within a CircleCI organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | An opaque identifier of an organization. |
| `group_id` | string | Yes | An opaque identifier of a group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Pipeline Config

**Slug:** `CIRCLECI_GET_PIPELINE_CONFIG`

Tool to fetch pipeline configuration by ID. Use when you need the source or compiled YAML of a specific pipeline.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pipeline_id` | string | Yes | The unique ID of the pipeline to fetch configuration for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Pipeline Definition

**Slug:** `CIRCLECI_GET_PIPELINE_DEFINITION`

Tool to retrieve a pipeline definition by project and definition ID. Use when you need details about a specific pipeline definition's configuration, sources, and metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | An opaque identifier of a project. |
| `pipeline_definition_id` | string | Yes | An opaque identifier of a pipeline definition. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Project

**Slug:** `CIRCLECI_GET_PROJECT`

Tool to retrieve a CircleCI project by its slug. Use when you need project details such as organization info, project ID, or VCS configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_slug` | string | Yes | Project slug in the form `vcs-slug/org-name/repo-name` (e.g., `gh/CircleCI-Public/circleci-cli`). The `/` characters may be URL-escaped. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Project Workflows

**Slug:** `CIRCLECI_GET_PROJECT_WORKFLOWS`

Tool to get summary metrics for all workflows of a project. Use when you need to analyze performance across all workflows, including success rates, duration metrics, throughput, and credits used.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `branch` | string | No | The name of a vcs branch. If not passed we will scope the API call to the default branch. |
| `page-token` | string | No | Token to retrieve the next page of results (for pagination). |
| `all-branches` | boolean | No | Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter. |
| `project_slug` | string | Yes | Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings). |
| `reporting-window` | string | No | The time window for the report. Specifies the reporting window for data aggregation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Test Metadata

**Slug:** `CIRCLECI_GET_TEST_METADATA`

Tool to fetch test metadata for a specific job. Use when you need detailed test results, run times, and failure messages after a job completes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of test results to return. Defaults to 30. |
| `job_number` | integer | Yes | The number of the job to fetch test metadata for. |
| `page-token` | string | No | A token to retrieve the next page of results. |
| `project_slug` | string | Yes | The project slug in the form 'vcs-slug/org-name/repo-name', e.g., 'gh/CircleCI-Public/circleci-cli'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Usage Export Job

**Slug:** `CIRCLECI_GET_USAGE_EXPORT_JOB`

Tool to retrieve a usage export job by organization ID and job ID. Use when you need to check the status or download URLs of a usage export job.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | An opaque identifier of an organization. |
| `usage_export_job_id` | string | Yes | An opaque identifier of a usage export job. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Information

**Slug:** `CIRCLECI_GET_USER_INFORMATION`

Tool to retrieve information about a CircleCI user by their unique ID. Use when you need user profile details after obtaining the user ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | The unique ID of the user. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Workflow Summary

**Slug:** `CIRCLECI_GET_WORKFLOW_SUMMARY`

Tool to get metrics and trends for a workflow. Use when you need workflow performance insights including success rates, duration metrics, and trends over time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `branch` | string | No | The name of a vcs branch. If not passed we will scope the API call to the default branch. |
| `all-branches` | boolean | No | Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter. |
| `project_slug` | string | Yes | Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings). |
| `workflow_name` | string | Yes | The name of the workflow. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Context Environment Variables

**Slug:** `CIRCLECI_LIST_CONTEXT_ENV_VARS`

Tool to list all environment variables for a specific context. Use when you need to retrieve or paginate through environment variables stored in a CircleCI context.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `context_id` | string | Yes | An opaque identifier of a context. |
| `page-token` | string | No | A token to specify which page of results to fetch. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Insights Branches

**Slug:** `CIRCLECI_LIST_INSIGHTS_BRANCHES`

Tool to get all branches for a project from CircleCI Insights. Use when you need to retrieve the list of branches that have workflow runs in the project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_slug` | string | Yes | Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings). |
| `workflow-name` | string | No | The name of a workflow. If not passed we will scope the API call to the project. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Insights Summary

**Slug:** `CIRCLECI_LIST_INSIGHTS_SUMMARY`

Tool to get summary metrics with trends for the entire organization and for each project. Use when you need organization-wide performance analytics across all projects.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org-slug` | string | Yes | Organization slug in the form `vcs-type/org-name`. Example: `gh/CircleCI-Public` or `bb/my-org`. |
| `project-names` | string | No | Filter by project names. Can be a single project name or multiple project names. |
| `reporting-window` | string ("last-7-days" | "last-30-days" | "last-60-days" | "last-90-days") | No | Reporting window for summary metrics. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Namespace Orbs

**Slug:** `CIRCLECI_LIST_NAMESPACE_ORBS`

Tool to list orbs in a CircleCI registry namespace with pagination support. Use when you need to browse available orbs in a namespace, filter by visibility (public/private), or retrieve orb statistics. Returns up to 20 orbs per page with cursor-based pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view` | string ("PUBLIC_ONLY" | "PRIVATE_ONLY") | No | Enum for orb visibility filter types. |
| `after` | string | No | Pagination cursor for fetching subsequent pages. Use empty string for the first page, then use the cursor value from previous response's edges. |
| `namespace` | string | No | The registry namespace name to query (e.g., 'circleci', 'myorg'). If not provided, queries all accessible namespaces. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Orb Categories

**Slug:** `CIRCLECI_LIST_ORB_CATEGORIES`

Tool to retrieve all CircleCI orb categories with pagination support. Use when you need to list available categories for orb classification. Returns up to 20 categories per page with cursor-based pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `after` | string | No | Pagination cursor for fetching subsequent result pages. Use empty string for first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Orbs

**Slug:** `CIRCLECI_LIST_ORBS`

Tool to list CircleCI orbs with pagination support via GraphQL API. Use when you need to browse available orbs, filter by certification status, or discover orbs with their usage statistics. Returns up to 20 orbs per page with cursor-based pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `after` | string | No | Cursor for pagination. Use empty string for the first page, then use the cursor from the previous response to get the next page. |
| `certifiedOnly` | boolean | No | Filter for certified orbs only (true) or include all orbs (false). Certified orbs are officially verified by CircleCI. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Organization Groups

**Slug:** `CIRCLECI_LIST_ORGANIZATION_GROUPS`

Tool to list all groups in a CircleCI organization. Use when you need to retrieve groups for an organization to manage permissions or view group memberships.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | The number of results per page. |
| `org_id` | string | Yes | An opaque identifier of an organization. |
| `page-token` | string | No | A token to specify which page of results to fetch. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Pages Summary

**Slug:** `CIRCLECI_LIST_PAGES_SUMMARY`

Tool to get summary metrics and trends for a project across its workflows and branches. Use when you need to analyze project performance, track success rates, throughput, credits usage, and duration trends.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `branches` | array | No | The names of VCS branches to include in branch-level workflow metrics. |
| `project_slug` | string | Yes | Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings). |
| `workflow-names` | array | No | The names of workflows to include in workflow-level metrics. |
| `reporting-window` | string ("last-7-days" | "last-24-hours" | "last-30-days" | "last-60-days" | "last-90-days") | No | Reporting window for summary metrics. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Pipeline Definitions

**Slug:** `CIRCLECI_LIST_PIPELINE_DEFINITIONS`

Tool to list all pipeline definitions for a specific project. Use when you need to retrieve available pipeline configurations for a project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | An opaque identifier of a project. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Pipelines

**Slug:** `CIRCLECI_LIST_PIPELINES`

Tool to get a list of pipelines for an organization. Use when you need to retrieve pipelines across multiple projects or for a specific organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mine` | boolean | No | Only include entries created by your user. |
| `org-slug` | string | No | Org slug in the form `vcs-slug/org-name`. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug` and replace the `org-name` with the organization ID (found in Organization Settings). |
| `page-token` | string | No | A token to retrieve the next page of results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Pipelines for Project

**Slug:** `CIRCLECI_LIST_PIPELINES_FOR_PROJECT`

Tool to list all pipelines for a specific project. Use when you need to retrieve the pipelines for a project (e.g., to display recent runs on a dashboard).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mine` | boolean | No | Only return pipelines triggered by the current user if true. |
| `branch` | string | No | Only return pipelines on this branch. |
| `page-token` | string | No | A token to retrieve the next page of results. |
| `project_slug` | string | Yes | The project slug in the form `vcs-slug/org-name/repo-name` (e.g., `github/CircleCI-Public/circleci-cli`). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Project Environment Variables

**Slug:** `CIRCLECI_LIST_PROJECT_ENV_VARS`

Tool to list all environment variables for a CircleCI project. Use when you need to retrieve project-level environment variables. Note that values are masked for security.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_slug` | string | Yes | Project slug in the form 'vcs-slug/org-name/repo-name'. The vcs-slug should be 'gh' (GitHub) or 'bb' (Bitbucket). Example: 'gh/CircleCI-Public/api-preview-docs'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Project Schedules

**Slug:** `CIRCLECI_LIST_PROJECT_SCHEDULES`

Tool to list all schedules for a specific project. Use when you need to retrieve scheduled pipeline triggers for a project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page-token` | string | No | A token to retrieve the next page of results. |
| `project_slug` | string | Yes | Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Self-Hosted Runners

**Slug:** `CIRCLECI_LIST_SELF_HOSTED_RUNNERS`

List self-hosted runners in CircleCI. Use this to retrieve information about your organization's self-hosted runners, optionally filtered by namespace or resource class. Useful for monitoring runner availability and status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `namespace` | string | No | Filter runners by namespace (e.g., 'my-namespace'). Returns all runners in the specified namespace. Must provide either this or resource_class (but not both). |
| `resource-class` | string | No | Filter runners by specific resource class (e.g., 'my-namespace/my-resource-class'). Returns only runners for this resource class. Must provide either this or namespace (but not both). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List User Collaborations

**Slug:** `CIRCLECI_LIST_USER_COLLABORATIONS`

Tool to retrieve organizations where the authenticated user has access. Use when you need to list all organizations a user can collaborate on.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Workflows by Pipeline ID

**Slug:** `CIRCLECI_LIST_WORKFLOWS_BY_PIPELINE_ID`

Tool to list all workflows associated with a specific pipeline. Use when you need to fetch or paginate through workflows by pipeline ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of workflows to return. Default is 20, maximum is 100. |
| `page-token` | string | No | Token to retrieve the next page of results (for pagination). |
| `pipeline_id` | string | Yes | The unique identifier of the pipeline. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Workflows Jobs Workflows

**Slug:** `CIRCLECI_LIST_WORKFLOWS_JOBS_WORKFLOWS`

Tool to get summary metrics for a project workflow's jobs. Use when you need performance analytics like success rates, duration statistics, and credit usage for jobs in a specific workflow.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `branch` | string | No | The name of a vcs branch. If not passed we will scope the API call to the default branch. |
| `job-name` | string | No | The name of the jobs you would like to filter from your workflow. If not specified, all workflow jobs will be returned. The job name can either be the full job name or just a substring of the job name. |
| `page-token` | string | No | A token to retrieve the next page of results. |
| `all-branches` | boolean | No | Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter. |
| `project_slug` | string | Yes | Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings). |
| `workflow_name` | string | Yes | The name of the workflow. |
| `reporting-window` | string ("last-7-days" | "last-24-hours" | "last-30-days" | "last-60-days" | "last-90-days") | No | Time window for calculating summary metrics. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Workflows Test Metrics

**Slug:** `CIRCLECI_LIST_WORKFLOWS_TEST_METRICS`

Tool to get test metrics for a project's workflows. Use when you need to analyze test performance, identify flaky tests, or find the slowest tests in a workflow.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `branch` | string | No | The name of a vcs branch. If not passed we will scope the API call to the default branch. |
| `all-branches` | boolean | No | Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter. |
| `project_slug` | string | Yes | Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings). |
| `workflow-name` | string | Yes | The name of the workflow. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Query Context

**Slug:** `CIRCLECI_QUERY_CONTEXT`

Tool to retrieve a CircleCI context by its UUID using GraphQL API. Use when you need to fetch context details including ID, name, and creation time. Returns null in the data field if the context ID does not exist.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The UUID of the context to query. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Query Namespace Exists

**Slug:** `CIRCLECI_QUERY_NAMESPACE_EXISTS`

Tool to determine if a namespace exists in the CircleCI registry. Use when you need to verify namespace existence before performing operations. Returns a boolean indicating whether the namespace exists.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The namespace name to check existence for (e.g., 'circleci', 'myorg'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Query Orb Category ID

**Slug:** `CIRCLECI_QUERY_ORB_CATEGORY_ID`

Tool to fetch the unique category ID for a CircleCI orb category by its name. Use when you need to categorize orbs or query category-specific information. Returns null in the data field if the category name does not exist.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the orb category to query (e.g., Deployment, Testing, Security, Notifications). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Query Orb Exists

**Slug:** `CIRCLECI_QUERY_ORB_EXISTS`

Tool to check if an orb exists in CircleCI registry and retrieve its privacy status. Use when you need to verify orb existence or check if an orb is private/public. Returns null in the data.orb field if the orb does not exist.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Full orb name in format 'namespace/orb' (e.g., 'circleci/node'). |
| `namespace` | string | No | Optional namespace name to verify its existence alongside the orb. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Query Orb ID

**Slug:** `CIRCLECI_QUERY_ORB_ID`

Tool to fetch an orb's ID and optionally its namespace ID by orb name. Use when you need to query orb identifiers for CircleCI orbs. The name parameter should be the full orb reference (namespace/orbname). Optionally provide the namespace parameter to also retrieve the namespace ID in the same call.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Full orb reference in format namespace/orbname (e.g., 'circleci/node', 'myorg/myorb'). |
| `namespace` | string | No | Namespace name to query the namespace ID (e.g., 'circleci', 'myorg'). Optional but recommended to get both orb and namespace IDs in one call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Query Orb Latest Version

**Slug:** `CIRCLECI_QUERY_ORB_LATEST_VERSION`

Tool to fetch the latest published version of a CircleCI orb. Use when you need to check the most recent version number of an orb for dependency management or updates. Returns null in the data field if the orb does not exist.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The orb reference in format 'namespace/orbname' (e.g., 'circleci/node', 'circleci/aws-cli'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Query Orb Source

**Slug:** `CIRCLECI_QUERY_ORB_SOURCE`

Tool to retrieve source code of a specific CircleCI orb version via GraphQL. Use when you need to access the YAML configuration or inspect the implementation of an orb version. Returns null if the orb version reference does not exist.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `orb_version_ref` | string | Yes | The orb reference including version information. Format: 'namespace/orb-name@version' (e.g., 'circleci/node@5.0.0'). The namespace identifies the orb publisher, orb-name is the orb identifier, and version is the specific version to retrieve source for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Query Plan Metrics

**Slug:** `CIRCLECI_QUERY_PLAN_METRICS`

Tool to query plan metrics including credit usage by project and organization for a date range. Use when you need to analyze credit consumption, compute time usage, or project-level metrics for an organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | The unique UUID of the organization to query plan metrics for. |
| `date_range` | object | Yes | Date range to filter metrics. Specify start and end dates in ISO 8601 format (YYYY-MM-DD). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Context Environment Variable (GraphQL)

**Slug:** `CIRCLECI_REMOVE_CONTEXT_ENV_VAR_GRAPHQL`

Tool to remove an environment variable from a CircleCI context using GraphQL API. Use when you need to delete a context-level environment variable by its name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `variable` | string | Yes | The name of the environment variable to remove from the context. |
| `context_id` | string | Yes | The UUID of the context containing the environment variable to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Rename Namespace

**Slug:** `CIRCLECI_RENAME_NAMESPACE`

Tool to rename a CircleCI namespace by its UUID identifier. Use when you need to change the name of an existing namespace. Returns the renamed namespace ID on success, or errors if the operation fails.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `newName` | string | Yes | The new name for the namespace. |
| `namespaceId` | string | Yes | The unique identifier (UUID) of the namespace to rename. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Store Environment Variable

**Slug:** `CIRCLECI_STORE_ENVIRONMENT_VARIABLE`

Tool to store an environment variable in a CircleCI context using GraphQL mutation. Use when you need to add or update an environment variable within a specific context.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `value` | string | Yes | The value of the environment variable to store. |
| `variable` | string | Yes | The name of the environment variable to store. |
| `context_id` | string | Yes | The UUID of the context to store the environment variable in. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Trigger Pipeline

**Slug:** `CIRCLECI_TRIGGER_PIPELINE`

Triggers a new CI/CD pipeline run for a specified CircleCI project. Use this tool to programmatically start a build on a specific branch or tag, optionally passing custom pipeline parameters for conditional workflow execution. Requires write access to the project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag` | string | No | The git tag to trigger the pipeline on. Use this to trigger builds for tagged releases. Cannot be used together with 'branch'. |
| `branch` | string | No | The branch name to trigger the pipeline on. If not specified, triggers on the project's default branch. Cannot be used together with 'tag'. |
| `parameters` | object | No | Pipeline parameters as key-value pairs to pass to the CircleCI config. These parameters must be declared in your .circleci/config.yml file. Useful for conditional workflow execution or dynamic configuration. |
| `project_slug` | string | Yes | Project identifier in the format 'vcs-slug/org-name/repo-name'. The vcs-slug should be 'gh' (GitHub) or 'bb' (Bitbucket). Example: 'gh/my-org/my-repo' for a GitHub project. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upsert Context Environment Variable

**Slug:** `CIRCLECI_UPSERT_CONTEXT_ENV_VAR`

Tool to add or update an environment variable in a CircleCI context. Use when you need to set or modify context-level environment variables for your CircleCI projects.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `value` | string | Yes | The value of the environment variable. |
| `context_id` | string | Yes | An opaque identifier of a context. |
| `env_var_name` | string | Yes | The name of the environment variable. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Validate Orb Config

**Slug:** `CIRCLECI_VALIDATE_ORB_CONFIG`

Tool to validate CircleCI orb YAML configuration using the orbConfig GraphQL query. Use when you need to verify that an orb definition is syntactically correct before publishing or using it. Returns validation status, any errors found, and the processed YAML output.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `orb_yaml` | string | Yes | The YAML configuration of the orb to validate. Must be a valid YAML string containing orb definition with version, description, commands, jobs, or executors. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |