- Category: developer tools
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 65
- Triggers: 0
- Slug:
CIRCLECI - Version: 20261101_00
Tools
Cancel Workflow
Cancel Workflow
Create Context
Create Context
CIRCLECI_CREATE_CONTEXTTool 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
Output
Create Context (GraphQL)
Create Context (GraphQL)
Create Context Restriction
Create Context Restriction
CIRCLECI_CREATE_CONTEXT_RESTRICTIONTool 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
Output
Create Organization Orb Allowlist
Create Organization Orb Allowlist
CIRCLECI_CREATE_ORGANIZATION_ORB_ALLOWLISTTool 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
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
Create Organization Project
Create Organization Project
CIRCLECI_CREATE_ORGANIZATION_PROJECTTool 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
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
Create Organization Group
Create Organization Group
Create Project Environment Variable
Create Project Environment Variable
CIRCLECI_CREATE_PROJECT_ENV_VARTool 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
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
Create Usage Export Job
Create Usage Export Job
CIRCLECI_CREATE_USAGE_EXPORT_JOBTool 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
Output
Delete Context (GraphQL)
Delete Context (GraphQL)
Delete Context Restriction
Delete Context Restriction
Delete Namespace Alias
Delete Namespace Alias
Delete Organization Orb Allowlist Entry
Delete Organization Orb Allowlist Entry
CIRCLECI_DELETE_ORGANIZATION_ORB_ALLOWLISTTool 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
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
Delete Organization Group
Delete Organization Group
Delete Project
Delete Project
CIRCLECI_DELETE_PROJECTTool 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
Output
Delete Project Environment Variable
Delete Project Environment Variable
CIRCLECI_DELETE_PROJECT_ENV_VARTool to delete an environment variable from a CircleCI project. Use when you need to remove an existing environment variable by name.Input Parameters
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
Get Context
Get Context
Get Current User
Get Current User
Get Flaky Tests
Get Flaky Tests
CIRCLECI_GET_FLAKY_TESTSTool 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
Output
Get Job Artifacts
Get Job Artifacts
CIRCLECI_GET_JOB_ARTIFACTSRetrieves 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
Output
Get Job Details
Get Job Details
CIRCLECI_GET_JOB_DETAILSTool 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
Output
Get Legacy Build Details
Get Legacy Build Details
Get Orb Details
Get Orb Details
CIRCLECI_GET_ORB_DETAILSTool 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
Output
Get Orb Version
Get Orb Version
CIRCLECI_GET_ORB_VERSIONTool 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
Output
Get Organization
Get Organization
CIRCLECI_GET_ORGANIZATIONTool 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
Output
Get Organization Group
Get Organization Group
Get Pipeline
Get Pipeline
Get Pipeline Config
Get Pipeline Config
Get Pipeline Definition
Get Pipeline Definition
Get Pipeline Values
Get Pipeline Values
Get Project
Get Project
CIRCLECI_GET_PROJECTTool 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
vcs-slug/org-name/repo-name (e.g., gh/CircleCI-Public/circleci-cli). The / characters may be URL-escaped.Output
Get Project Workflows
Get Project Workflows
CIRCLECI_GET_PROJECT_WORKFLOWSGet summary metrics for a project’s workflows, including success rates, duration, throughput, and credits used. Results are paginated; use the returned next-page token to retrieve further workflows.Input Parameters
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
Get Test Metadata
Get Test Metadata
Get Usage Export Job
Get Usage Export Job
Get User Information
Get User Information
Get Workflow Summary
Get Workflow Summary
CIRCLECI_GET_WORKFLOW_SUMMARYTool 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
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
Inspect Workflow
Inspect Workflow
List Context Environment Variables
List Context Environment Variables
List Insights Branches
List Insights Branches
CIRCLECI_LIST_INSIGHTS_BRANCHESTool 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
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
List Insights Summary
List Insights Summary
CIRCLECI_LIST_INSIGHTS_SUMMARYTool 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
vcs-type/org-name. Example: gh/CircleCI-Public or bb/my-org.Output
List Namespace Orbs
List Namespace Orbs
CIRCLECI_LIST_NAMESPACE_ORBSTool 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
Output
List Orb Categories
List Orb Categories
List Orbs
List Orbs
CIRCLECI_LIST_ORBSTool 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
Output
List Organization Groups
List Organization Groups
List Pages Summary
List Pages Summary
CIRCLECI_LIST_PAGES_SUMMARYTool 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
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
List Pipeline Definitions
List Pipeline Definitions
List Pipelines
List Pipelines
CIRCLECI_LIST_PIPELINESTool 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
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
List Pipelines for Project
List Pipelines for Project
CIRCLECI_LIST_PIPELINES_FOR_PROJECTList pipelines for a specific project, optionally filtered by branch or current user. Results are paginated; use the returned next-page token to retrieve further pipelines.Input Parameters
vcs-slug/org-name/repo-name (e.g., github/CircleCI-Public/circleci-cli).Output
List Project Environment Variables
List Project Environment Variables
CIRCLECI_LIST_PROJECT_ENV_VARSList project-level environment variables for a CircleCI project. Values are masked for security; results are paginated, with a token for retrieving the next page.Input Parameters
Output
List Project Schedules
List Project Schedules
CIRCLECI_LIST_PROJECT_SCHEDULESList scheduled pipeline triggers for a specific project. Results are paginated; use the returned next-page token to retrieve further schedules.Input Parameters
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
List Self-Hosted Runners
List Self-Hosted Runners
CIRCLECI_LIST_SELF_HOSTED_RUNNERSList CircleCI self-hosted runners for exactly one namespace or resource class. A 404 response is returned as an empty list.Input Parameters
Output
List User Collaborations
List User Collaborations
List Workflows by Pipeline ID
List Workflows by Pipeline ID
List Workflows Jobs Workflows
List Workflows Jobs Workflows
CIRCLECI_LIST_WORKFLOWS_JOBS_WORKFLOWSTool 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
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
List Workflows Test Metrics
List Workflows Test Metrics
CIRCLECI_LIST_WORKFLOWS_TEST_METRICSTool 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
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
Query Context
Query Context
Query Namespace Exists
Query Namespace Exists
Query Orb Category ID
Query Orb Category ID
Query Orb Exists
Query Orb Exists
Query Orb ID
Query Orb ID
CIRCLECI_QUERY_ORB_IDTool 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
Output
Query Orb Latest Version
Query Orb Latest Version
Query Orb Source
Query Orb Source
CIRCLECI_QUERY_ORB_SOURCETool 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
Output
Query Plan Metrics
Query Plan Metrics
CIRCLECI_QUERY_PLAN_METRICSTool 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
Output
Remove Context Environment Variable (GraphQL)
Remove Context Environment Variable (GraphQL)
Rename Namespace
Rename Namespace
Rerun Workflow
Rerun Workflow
Store Environment Variable
Store Environment Variable
Trigger Pipeline
Trigger Pipeline
CIRCLECI_TRIGGER_PIPELINETriggers 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
Output
Upsert Context Environment Variable
Upsert Context Environment Variable
Validate Orb Config
Validate Orb Config
CIRCLECI_VALIDATE_ORB_CONFIGTool 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.