Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

CircleCI (BYOK) — connector documentation

  • MCP endpoint: https://byok-circleci.connectorbay.com/mcp
  • REST API: POST https://byok-circleci.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-circleci.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own CircleCI personal API token, sent in the X-Upstream-Key header of every request (never stored, logged or cached)
  • Health: https://byok-circleci.connectorbay.com/health · Tool schemas: https://byok-circleci.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-circleci · agent@connectorbay.com

What CircleCI (BYOK) is for

CircleCI (BYOK) lets an AI assistant read your own CircleCI data through the CircleCI API with a key you supply (personal API token). Read-only: 12 tools (get_me, list_collaborations, get_project, list_project_pipelines, get_pipeline, list_pipeline_workflows, get_workflow, list_workflow_jobs, get_job, get_workflow_metrics, list_flaky_tests, list_contexts). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to circleci.com. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by CircleCI. CircleCI and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "Which CircleCI user is my token connected to?"
  • "Which CircleCI organizations am I part of?"
  • "Show details of my CircleCI project"
  • "What were the latest CircleCI pipelines on my project?"
  • "Show this CircleCI pipeline"
  • "Which workflows ran in this CircleCI pipeline and did they pass?"

What it does

  • get_me: Show the CircleCI user the token belongs to: id, login and name.
  • list_collaborations: List the organizations and accounts the CircleCI user collaborates in, with slug, name and VCS type.
  • get_project: Get one CircleCI project by slug: name, organization, ids and VCS information with default branch.
  • list_project_pipelines: List recent pipelines of a CircleCI project (newest first) with number, state, trigger, branch, commit subject and errors. Page with next_page_token.
  • get_pipeline: Get one CircleCI pipeline by id: number, state, trigger, branch, revision and commit subject.
  • list_pipeline_workflows: List the workflows of a CircleCI pipeline with name, status, start and stop times. Page with next_page_token.
  • get_workflow: Get one CircleCI workflow by id: name, status, pipeline, who started it, and start and stop times.
  • list_workflow_jobs: List the jobs of a CircleCI workflow with name, number, type, status, dependencies and times. Page with next_page_token.
  • get_job: Get one CircleCI job by id: name, number, status, workflow, pipeline and times.
  • get_workflow_metrics: Get CircleCI Insights metrics per workflow of a project: runs, success rate, failed runs, credits used and duration statistics over a reporting window.
  • list_flaky_tests: List flaky tests CircleCI Insights found in a project, with test name, class, job, workflow, file and how many times it flaked.
  • list_contexts: List CircleCI contexts (shared variable groups) of an owner by name and creation date. Variable values are not returned.

BYOK key

You bring your own CircleCI personal API token (https://app.circleci.com/settings/user/tokens). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to circleci.com over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Data sources

Live from the CircleCI API (circleci.com) with a BYOK key; documentation: https://circleci.com/docs/api/v2/index.html. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by CircleCI. CircleCI and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your CircleCI account.

Built for: Worldwide. Languages: English.