CircleCI · Capability

CircleCI REST API v1 — Project

CircleCI REST API v1 — Project. 2 operations. Lead operation: Follow a project. Self-contained Naftiko capability covering one Circleci business surface.

Run with Naftiko CircleciProject

What You Can Do

POST
Followproject — Follow a project
/v1/project/{vcs-type}/{username}/{project}/follow
GET
Listprojects — List followed projects
/v1/projects

MCP Tools

follow-project

Follow a project

list-followed-projects

List followed projects

read-only idempotent

Capability Spec

rest-api-v1-project.yaml Raw ↑
naftiko: 1.0.0-alpha2
info:
  label: CircleCI REST API v1 — Project
  description: 'CircleCI REST API v1 — Project. 2 operations. Lead operation: Follow a project. Self-contained Naftiko capability
    covering one Circleci business surface.'
  tags:
  - Circleci
  - Project
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    CIRCLECI_API_KEY: CIRCLECI_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-api-v1-project
    baseUri: https://circleci.com/api/v1.1
    description: CircleCI REST API v1 — Project business capability. Self-contained, no shared references.
    resources:
    - name: project-vcs-type-username-project-follow
      path: /project/{vcs-type}/{username}/{project}/follow
      operations:
      - name: followproject
        method: POST
        description: Follow a project
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: projects
      path: /projects
      operations:
      - name: listprojects
        method: GET
        description: List followed projects
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: Circle-Token
      value: '{{env.CIRCLECI_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: rest-api-v1-project-rest
    port: 8080
    description: REST adapter for CircleCI REST API v1 — Project. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/project/{vcs-type}/{username}/{project}/follow
      name: project-vcs-type-username-project-follow
      description: REST surface for project-vcs-type-username-project-follow.
      operations:
      - method: POST
        name: followproject
        description: Follow a project
        call: rest-api-v1-project.followproject
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/projects
      name: projects
      description: REST surface for projects.
      operations:
      - method: GET
        name: listprojects
        description: List followed projects
        call: rest-api-v1-project.listprojects
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-api-v1-project-mcp
    port: 9090
    transport: http
    description: MCP adapter for CircleCI REST API v1 — Project. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: follow-project
      description: Follow a project
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-api-v1-project.followproject
      outputParameters:
      - type: object
        mapping: $.
    - name: list-followed-projects
      description: List followed projects
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-api-v1-project.listprojects
      outputParameters:
      - type: object
        mapping: $.