productivity
CircleCI MCP, CLI, and Lua Integration for AI Agents
CircleCI integration docs for AI agents: MCP gateway setup, CircleCI CLI commands, Lua API reference, credentials, and function schemas.CircleCI for agents
Credentials can be configured manually in web or CLI hosts.
Use this integration from Lua code mode, the headless integrations CLI, or the KosmoKrator MCP gateway. The same package metadata powers all three surfaces.
Agent Surfaces
Machine-Readable Metadata
Function Catalog
| Function | Type | Parameters | Description |
|---|---|---|---|
circleci.circleci_api_delete | Write write | 0 | Call any CircleCI API DELETE endpoint path. |
circleci.circleci_api_get | Read read | 0 | Call any CircleCI API GET endpoint path. |
circleci.circleci_api_patch | Write write | 0 | Call any CircleCI API PATCH endpoint path. |
circleci.circleci_api_post | Write write | 0 | Call any CircleCI API POST endpoint path. |
circleci.circleci_api_put | Write write | 0 | Call any CircleCI API PUT endpoint path. |
circleci.circleci_approve_workflow_job | Write write | 0 | Approve a workflow approval job. |
circleci.circleci_cancel_job_by_id | Write write | 0 | Cancel a job by job ID. |
circleci.circleci_cancel_job_by_number | Write write | 0 | Cancel a job by project slug and job number. |
circleci.circleci_cancel_workflow | Write write | 0 | Cancel a workflow. |
circleci.circleci_continue_pipeline | Write write | 0 | Continue a setup workflow pipeline with generated configuration. |
circleci.circleci_create_checkout_key | Write write | 0 | Create a checkout key for a project. |
circleci.circleci_create_context | Write write | 0 | Create a CircleCI context. |
circleci.circleci_create_context_restriction | Write write | 0 | Create a context restriction. |
circleci.circleci_create_project_env_var | Write write | 0 | Create a project environment variable. |
circleci.circleci_create_schedule | Write write | 0 | Create a schedule trigger for a project. |
circleci.circleci_create_webhook | Write write | 0 | Create an outbound webhook. |
circleci.circleci_delete_checkout_key | Write write | 0 | Delete a project checkout key. |
circleci.circleci_delete_context | Write write | 0 | Delete a context and its environment variables. |
circleci.circleci_delete_context_env_var | Write write | 0 | Delete a context environment variable. |
circleci.circleci_delete_context_restriction | Write write | 0 | Delete a context restriction. |
circleci.circleci_delete_project | Write write | 0 | Delete a project by project slug. |
circleci.circleci_delete_project_env_var | Write write | 0 | Delete a project environment variable. |
circleci.circleci_delete_schedule | Write write | 0 | Delete a schedule by ID. |
circleci.circleci_delete_webhook | Write write | 0 | Delete an outbound webhook. |
circleci.circleci_get_checkout_key | Read read | 0 | Get a project checkout key by fingerprint. |
circleci.circleci_get_context | Read read | 0 | Get a context by ID. |
circleci.circleci_get_current_user | Read read | 0 | Get the authenticated CircleCI user profile. |
circleci.circleci_get_job_details | Read read | 0 | Get job details by project slug and job number. |
circleci.circleci_get_pipeline | Read read | 0 | Get details for a pipeline by ID. |
circleci.circleci_get_pipeline_config | Read read | 0 | Get compiled configuration for a pipeline. |
circleci.circleci_get_pipeline_values | Read read | 0 | Get pipeline parameter values for a pipeline. |
circleci.circleci_get_project | Read read | 0 | Get a project by project slug. |
circleci.circleci_get_project_env_var | Read read | 0 | Get a masked project environment variable. |
circleci.circleci_get_project_insights_summary | Read read | 0 | Get project summary metrics and trends. |
circleci.circleci_get_project_pipeline_by_number | Read read | 0 | Get a project pipeline by pipeline number. |
circleci.circleci_get_project_settings | Read read | 0 | Get project settings. |
circleci.circleci_get_schedule | Read read | 0 | Get a schedule by ID. |
circleci.circleci_get_user | Read read | 0 | Get a CircleCI user by ID. |
circleci.circleci_get_webhook | Read read | 0 | Get an outbound webhook. |
circleci.circleci_get_workflow | Read read | 0 | Get details for a workflow. |
circleci.circleci_get_workflow_job_timeseries | Read read | 0 | Get timeseries data for a workflow job. |
circleci.circleci_get_workflow_metrics | Read read | 0 | Get metrics and recent runs for a workflow. |
circleci.circleci_list_checkout_keys | Read read | 0 | List checkout keys for a project. |
circleci.circleci_list_collaborations | Read read | 0 | List VCS collaborations for the authenticated user. |
circleci.circleci_list_context_env_vars | Read read | 0 | List environment variables in a context without values. |
circleci.circleci_list_context_restrictions | Read read | 0 | List context restrictions. |
circleci.circleci_list_contexts | Read read | 0 | List contexts for an owner. |
circleci.circleci_list_flaky_tests | Read read | 0 | List flaky tests for a project. |
circleci.circleci_list_insight_branches | Read read | 0 | List branches with insight data for a project. |
circleci.circleci_list_job_artifacts | Read read | 0 | List artifacts for a job. |
circleci.circleci_list_job_tests | Read read | 0 | List test metadata for a job. |
circleci.circleci_list_pipeline_workflows | Read read | 0 | List workflows for a pipeline. |
circleci.circleci_list_pipelines | Read read | 0 | List pipelines visible to the authenticated user or organization. |
circleci.circleci_list_project_env_vars | Read read | 0 | List masked project environment variables. |
circleci.circleci_list_project_pipelines | Read read | 0 | List pipelines for a project. |
circleci.circleci_list_projects | Read read | 0 | List projects for an organization. |
circleci.circleci_list_schedule_triggers | Read read | 0 | List schedule triggers for a project. |
circleci.circleci_list_webhooks | Read read | 0 | List outbound webhooks. |
circleci.circleci_list_workflow_job_metrics | Read read | 0 | List job metrics for a project workflow. |
circleci.circleci_list_workflow_jobs | Read read | 0 | List jobs for a workflow. |
circleci.circleci_list_workflow_metrics | Read read | 0 | List workflow metrics for a project. |
circleci.circleci_list_workflows | Read read | 1 | List all workflows for a specific CircleCI pipeline. Shows workflow names, statuses (running, success, failed, etc.), and timing information. |
circleci.circleci_rerun_workflow | Write write | 0 | Rerun a workflow. |
circleci.circleci_trigger_pipeline | Write write | 0 | Trigger a new pipeline for a project. |
circleci.circleci_update_project_settings | Write write | 0 | Update project settings. |
circleci.circleci_update_schedule | Write write | 0 | Update a schedule by ID. |
circleci.circleci_update_webhook | Write write | 0 | Update an outbound webhook. |
circleci.circleci_upsert_context_env_var | Write write | 0 | Add or update a context environment variable. |