← Tools Reference

CircleCI

CircleCI integration (Developer Tools). Imported from open-connector.

API key11 toolshttps://circleci.com/api/v2
GET
circleci_get_current_user
Get the currently authenticated CircleCI user profile.

/me

GET
circleci_get_project
Get CircleCI project details by project slug.

/project/{projectSlug}

1 parameter
ParamTypeRequiredDescription
projectSlugstringrequiredProject slug in the form `vcs-slug/org-name/repo-name`. GitHub App and GitLab p…
GET
circleci_list_pipelines_for_project
List CircleCI pipelines for a project.

/project/{projectSlug}/pipeline

3 parameters
ParamTypeRequiredDescription
projectSlugstringrequiredProject slug in the form `vcs-slug/org-name/repo-name`. GitHub App and GitLab p…
branchstringoptionalThe VCS branch name.
pageTokenstringoptionalPagination token returned by CircleCI.
GET
circleci_get_pipeline
Get a CircleCI pipeline by pipeline ID.

/pipeline/{pipelineId}

1 parameter
ParamTypeRequiredDescription
pipelineIdstringrequiredThe unique ID of the CircleCI pipeline.
GET
circleci_list_workflows_by_pipeline
List workflows for a CircleCI pipeline.

/pipeline/{pipelineId}/workflow

2 parameters
ParamTypeRequiredDescription
pipelineIdstringrequiredThe unique ID of the CircleCI pipeline.
pageTokenstringoptionalPagination token returned by CircleCI.
GET
circleci_get_workflow_summary
Get CircleCI Insights summary metrics for a workflow.

/insights/{projectSlug}/workflows/

4 parameters
ParamTypeRequiredDescription
projectSlugstringrequiredProject slug in the form `vcs-slug/org-name/repo-name`. GitHub App and GitLab p…
workflowNamestringrequiredThe CircleCI workflow name.
allBranchesbooleanoptionalWhether to aggregate across all branches.
branchstringoptionalThe VCS branch name.
GET
circleci_get_job_details
Get CircleCI job details by project slug and job number.

/project/{projectSlug}/job/

2 parameters
ParamTypeRequiredDescription
projectSlugstringrequiredProject slug in the form `vcs-slug/org-name/repo-name`. GitHub App and GitLab p…
jobNumberintegerrequiredThe CircleCI job number.
GET
circleci_get_job_artifacts
List artifacts for a CircleCI job.

/project/{projectSlug}/

2 parameters
ParamTypeRequiredDescription
projectSlugstringrequiredProject slug in the form `vcs-slug/org-name/repo-name`. GitHub App and GitLab p…
jobNumberintegerrequiredThe CircleCI job number.
GET
circleci_list_insights_summary
Get CircleCI Insights summary metrics for an organization.

/insights/{orgSlug}/summary

2 parameters
ParamTypeRequiredDescription
orgSlugstringrequiredOrganization slug in the form `vcs-slug/org-name`.
reportingWindowstringoptionalThe reporting window used by CircleCI Insights.
POST
circleci_trigger_pipeline
Trigger a new CircleCI pipeline for a project.

/project/{projectSlug}/pipeline

4 parameters
ParamTypeRequiredDescription
projectSlugstringrequiredProject slug in the form `vcs-slug/org-name/repo-name`. GitHub App and GitLab p…
branchstringoptionalThe VCS branch name.
tagstringoptionalThe VCS tag name.
parametersobjectoptionalPipeline parameters declared in `.circleci/config.yml`.
GET
circleci_list_project_env_vars
List masked CircleCI environment variables for a project.

/project/{projectSlug}/envvar

1 parameter
ParamTypeRequiredDescription
projectSlugstringrequiredProject slug in the form `vcs-slug/org-name/repo-name`. GitHub App and GitLab p…