Skip to main content

​
At a glance

  • Availability: Experimental (how to enable).
  • Authentication: API key.
  • Connection: The key from CIRCLECI_TOKEN is sent as the Circle-Token header.
  • Provider documentation: Authentication reference.

​
Credentials

Set these per environment. See Connect an integration.

​
Setup

  1. Sign in to CircleCI: Go to https://app.circleci.com and sign in (the free plan with a connected GitHub repo is sufficient for testing).
  2. Create a personal API token: Open User Settings > Personal API Tokens (https://app.circleci.com/settings/user/tokens) and create a token.
  3. Set the environment variable: Add the token to your .env as CIRCLECI_TOKEN=…
  4. Find your project slug: Slugs look like gh/your-org/your-repo (or circleci/<org-id>/<project-id> for GitLab and GitHub App projects). Run List Pipelines with it to verify access.

​
Provider notes

  • CircleCI authenticates with a ‘Circle-Token’ header
  • Project slugs contain slashes (vcs/org/repo) and are passed verbatim in the URL path
  • Personal tokens act with your user’s permissions across all your organizations
Provider API reference.

​
Tools

​
Verify the connection

Call a read tool such as circleci__list_pipelines with arguments for your account. Confirm that the result comes from the intended account or workspace before enabling write tools.