Can I use CircleCI as a CLI?

Yes. KosmoKrator exposes a CircleCI CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose CircleCI through MCP?

Yes. The KosmoKrator MCP gateway can expose selected CircleCI tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are CircleCI credentials stored?

CircleCI credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for CircleCI MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

devtools

CircleCI CLI for AI Agents

Use the CircleCI CLI from KosmoKrator to call CircleCI tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.

7 functions 6 read 1 write Bearer token auth

Submit CircleCI feedback View package source

CircleCI CLI Setup

CircleCI can be configured headlessly with `kosmokrator integrations:configure circleci`.

# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash

# Configure and verify this integration.
kosmokrator integrations:configure circleci --set access_token="$CIRCLECI_ACCESS_TOKEN" --enable --read allow --write ask --json
kosmokrator integrations:doctor circleci --json
kosmokrator integrations:status --json

Credentials

Authentication type: Bearer token bearer_token. Configure credentials once, then use the same stored profile from scripts, coding CLIs, Lua code mode, and the MCP gateway.

Key	Env var	Type	Required	Label
`access_token`	`CIRCLECI_ACCESS_TOKEN`	Secret `secret`	yes	Personal API Token
`url`	`CIRCLECI_URL`	URL `url`	no	CircleCI API URL

Call CircleCI Headlessly

Use the generic call form when another coding CLI or script needs a stable universal interface.

kosmo integrations:call circleci.circleci_list_pipelines '{
  "orgSlug": "example_orgSlug",
  "branch": "example_branch",
  "limit": 1,
  "page_token": "example_page_token"
}' --json

Use the provider shortcut form for shorter human-facing commands.

kosmo integrations:circleci circleci_list_pipelines '{
  "orgSlug": "example_orgSlug",
  "branch": "example_branch",
  "limit": 1,
  "page_token": "example_page_token"
}' --json

Agent Discovery Commands

These commands return structured output for coding agents that need to inspect capabilities before choosing a function.

kosmo integrations:docs circleci --json
kosmo integrations:docs circleci.circleci_list_pipelines --json
kosmo integrations:schema circleci.circleci_list_pipelines --json
kosmo integrations:search "CircleCI" --json
kosmo integrations:list --json

All CLI Functions

Every function below can be called headlessly. The generic form is stable across all integrations; the provider shortcut is shorter but specific to CircleCI.

`circleci.circleci_list_pipelines`

Read read

List recent CI/CD pipelines in CircleCI. Filter by organization slug and branch. Returns pipeline IDs, status, trigger information, and revision details.

Parameters: orgSlug, branch, limit, page_token

Generic CLI call

kosmo integrations:call circleci.circleci_list_pipelines '{"orgSlug":"example_orgSlug","branch":"example_branch","limit":1,"page_token":"example_page_token"}' --json

Provider shortcut

kosmo integrations:circleci circleci_list_pipelines '{"orgSlug":"example_orgSlug","branch":"example_branch","limit":1,"page_token":"example_page_token"}' --json

`circleci.circleci_get_pipeline`

Read read

Get detailed information about a specific CircleCI pipeline, including its status, configuration, trigger source, and commit details.

Parameters: id

Generic CLI call

kosmo integrations:call circleci.circleci_get_pipeline '{"id":"example_id"}' --json

Provider shortcut

kosmo integrations:circleci circleci_get_pipeline '{"id":"example_id"}' --json

`circleci.circleci_list_workflows`

Read read

List all workflows for a specific CircleCI pipeline. Shows workflow names, statuses (running, success, failed, etc.), and timing information.

Parameters: pipeline_id

Generic CLI call

kosmo integrations:call circleci.circleci_list_workflows '{"pipeline_id":"example_pipeline_id"}' --json

Provider shortcut

kosmo integrations:circleci circleci_list_workflows '{"pipeline_id":"example_pipeline_id"}' --json

`circleci.circleci_get_workflow`

Read read

Get detailed information about a specific CircleCI workflow, including its status, timing, duration, and associated project.

Parameters: id

Generic CLI call

kosmo integrations:call circleci.circleci_get_workflow '{"id":"example_id"}' --json

Provider shortcut

kosmo integrations:circleci circleci_get_workflow '{"id":"example_id"}' --json

`circleci.circleci_list_projects`

Read read

List all projects in a CircleCI organization. Returns project slugs, repository URLs, and VCS provider information.

Parameters: orgSlug, limit

Generic CLI call

kosmo integrations:call circleci.circleci_list_projects '{"orgSlug":"example_orgSlug","limit":1}' --json

Provider shortcut

kosmo integrations:circleci circleci_list_projects '{"orgSlug":"example_orgSlug","limit":1}' --json

`circleci.circleci_trigger_pipeline`

Write write

Trigger a new CI/CD pipeline on a CircleCI project. Specify the organization, project, branch, and optional pipeline parameters.

Parameters: orgSlug, projectSlug, branch, parameters

Generic CLI call

kosmo integrations:call circleci.circleci_trigger_pipeline '{"orgSlug":"example_orgSlug","projectSlug":"example_projectSlug","branch":"example_branch","parameters":"example_parameters"}' --json

Provider shortcut

kosmo integrations:circleci circleci_trigger_pipeline '{"orgSlug":"example_orgSlug","projectSlug":"example_projectSlug","branch":"example_branch","parameters":"example_parameters"}' --json

`circleci.circleci_get_current_user`

Read read

Get the current authenticated CircleCI user profile. Returns login, name, and account details. Useful for verifying API token validity.

Parameters: none

Generic CLI call

kosmo integrations:call circleci.circleci_get_current_user '{}' --json

Provider shortcut

kosmo integrations:circleci circleci_get_current_user '{}' --json

Function Schemas

Use these parameter tables when building CLI payloads without calling integrations:schema first.

`circleci.circleci_list_pipelines`

List recent CI/CD pipelines in CircleCI. Filter by organization slug and branch. Returns pipeline IDs, status, trigger information, and revision details.

Operation: Read read
Schema command: kosmo integrations:schema circleci.circleci_list_pipelines --json

Parameter	Type	Required	Description
`orgSlug`	string	yes	Organization slug (e.g., "gh/my-org" for GitHub, "bb/my-org" for Bitbucket).
`branch`	string	no	Filter pipelines by branch name (e.g., "main", "develop").
`limit`	integer	no	Maximum number of pipelines to return (default: 20, max: 100).
`page_token`	string	no	Pagination token from a previous response to fetch the next page.

`circleci.circleci_get_pipeline`

Get detailed information about a specific CircleCI pipeline, including its status, configuration, trigger source, and commit details.

Operation: Read read
Schema command: kosmo integrations:schema circleci.circleci_get_pipeline --json

Parameter	Type	Required	Description
`id`	string	yes	The pipeline ID (UUID).

`circleci.circleci_list_workflows`

List all workflows for a specific CircleCI pipeline. Shows workflow names, statuses (running, success, failed, etc.), and timing information.

Operation: Read read
Schema command: kosmo integrations:schema circleci.circleci_list_workflows --json

Parameter	Type	Required	Description
`pipeline_id`	string	yes	The pipeline ID (UUID) to list workflows for.

`circleci.circleci_get_workflow`

Get detailed information about a specific CircleCI workflow, including its status, timing, duration, and associated project.

Operation: Read read
Schema command: kosmo integrations:schema circleci.circleci_get_workflow --json

Parameter	Type	Required	Description
`id`	string	yes	The workflow ID (UUID).

`circleci.circleci_list_projects`

List all projects in a CircleCI organization. Returns project slugs, repository URLs, and VCS provider information.

Operation: Read read
Schema command: kosmo integrations:schema circleci.circleci_list_projects --json

Parameter	Type	Required	Description
`orgSlug`	string	yes	Organization slug (e.g., "gh/my-org" for GitHub, "bb/my-org" for Bitbucket).
`limit`	integer	no	Maximum number of projects to return.

`circleci.circleci_trigger_pipeline`

Trigger a new CI/CD pipeline on a CircleCI project. Specify the organization, project, branch, and optional pipeline parameters.

Operation: Write write
Schema command: kosmo integrations:schema circleci.circleci_trigger_pipeline --json

Parameter	Type	Required	Description
`orgSlug`	string	yes	Organization slug (e.g., "gh/my-org" for GitHub, "bb/my-org" for Bitbucket).
`projectSlug`	string	yes	Project slug / repository name (e.g., "my-repo").
`branch`	string	no	The branch to run the pipeline on (e.g., "main"). Defaults to the project's default branch.
`parameters`	object	no	Pipeline parameters to pass (for parameterized configs). Pass as a JSON object with string/boolean/number values.

`circleci.circleci_get_current_user`

Get the current authenticated CircleCI user profile. Returns login, name, and account details. Useful for verifying API token validity.

Operation: Read read
Schema command: kosmo integrations:schema circleci.circleci_get_current_user --json

Parameter	Type	Required	Description
No parameters.

Permissions

Headless calls still follow the integration read/write permission policy. Configure read/write defaults with integrations:configure. Add --force only for trusted automation that should bypass that policy.