Lichess API — Bulk pairings

naftiko: 1.0.0-alpha2
info:
  label: Lichess API — Bulk pairings
  description: 'Lichess API — Bulk pairings. 6 operations. Lead operation: View your bulk pairings. Self-contained Naftiko capability covering one Lichess business surface.'
  tags:
  - Lichess
  - Bulk pairings
  created: '2026-05-25'
  modified: '2026-05-25'
binds:
- namespace: env
  keys:
    LICHESS_API_TOKEN: LICHESS_API_TOKEN
capability:
  consumes:
  - type: http
    namespace: bulk-pairings
    baseUri: https://lichess.org
    description: Lichess Bulk pairings business capability. Self-contained, no shared references.
    resources:
    - name: bulk-pairing
      path: /api/bulk-pairing
      operations:
      - name: bulkpairinglist
        method: GET
        description: 'View your bulk pairings'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: bulkpairingcreate
        method: POST
        description: 'Create a bulk pairing'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          required: false
    - name: bulk-pairing-id-start-clocks
      path: /api/bulk-pairing/{id}/start-clocks
      operations:
      - name: bulkpairingstartclocks
        method: POST
        description: 'Manually start clocks'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
    - name: bulk-pairing-id
      path: /api/bulk-pairing/{id}
      operations:
      - name: bulkpairingget
        method: GET
        description: 'Show a bulk pairing'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
      - name: bulkpairingdelete
        method: DELETE
        description: 'Cancel a bulk pairing'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
    - name: bulk-pairing-id-games
      path: /api/bulk-pairing/{id}/games
      operations:
      - name: bulkpairingidgamesget
        method: GET
        description: 'Export games of a bulk pairing'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: moves
          in: query
          type: string
          required: false
        - name: pgnInJson
          in: query
          type: string
          required: false
        - name: tags
          in: query
          type: string
          required: false
        - name: clocks
          in: query
          type: string
          required: false
        - name: evals
          in: query
          type: string
          required: false
        - name: accuracy
          in: query
          type: string
          required: false
        - name: opening
          in: query
          type: string
          required: false
        - name: division
          in: query
          type: string
          required: false
        - name: literate
          in: query
          type: string
          required: false
    authentication:
      type: bearer
      value: '{{env.LICHESS_API_TOKEN}}'
      placement: header
  exposes:
  - type: rest
    namespace: bulk-pairings-rest
    port: 8080
    description: REST adapter for Lichess Bulk pairings. One Spectral-compliant resource per consumed operation.
    resources:
    - path: /v1/api/bulk-pairing
      name: bulk-pairing
      description: REST surface for bulk-pairing.
      operations:
      - method: GET
        name: bulkpairinglist
        description: 'View your bulk pairings'
        call: bulk-pairings.bulkpairinglist
        with:
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: bulkpairingcreate
        description: 'Create a bulk pairing'
        call: bulk-pairings.bulkpairingcreate
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/bulk-pairing/{id}/start-clocks
      name: bulk-pairing-id-start-clocks
      description: REST surface for bulk-pairing-id-start-clocks.
      operations:
      - method: POST
        name: bulkpairingstartclocks
        description: 'Manually start clocks'
        call: bulk-pairings.bulkpairingstartclocks
        with:
          id: rest.path.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/bulk-pairing/{id}
      name: bulk-pairing-id
      description: REST surface for bulk-pairing-id.
      operations:
      - method: GET
        name: bulkpairingget
        description: 'Show a bulk pairing'
        call: bulk-pairings.bulkpairingget
        with:
          id: rest.path.id
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: bulkpairingdelete
        description: 'Cancel a bulk pairing'
        call: bulk-pairings.bulkpairingdelete
        with:
          id: rest.path.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/bulk-pairing/{id}/games
      name: bulk-pairing-id-games
      description: REST surface for bulk-pairing-id-games.
      operations:
      - method: GET
        name: bulkpairingidgamesget
        description: 'Export games of a bulk pairing'
        call: bulk-pairings.bulkpairingidgamesget
        with:
          id: rest.path.id
          moves: rest.query.moves
          pgnInJson: rest.query.pgnInJson
          tags: rest.query.tags
          clocks: rest.query.clocks
          evals: rest.query.evals
          accuracy: rest.query.accuracy
          opening: rest.query.opening
          division: rest.query.division
          literate: rest.query.literate
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: bulk-pairings-mcp
    port: 9090
    transport: http
    description: MCP adapter for Lichess Bulk pairings. One tool per consumed operation.
    tools:
    - name: lichess-bulkpairinglist
      description: 'View your bulk pairings'
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: bulk-pairings.bulkpairinglist
      with:
      outputParameters:
      - type: object
        mapping: $.
    - name: lichess-bulkpairingcreate
      description: 'Create a bulk pairing'
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: bulk-pairings.bulkpairingcreate
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: lichess-bulkpairingstartclocks
      description: 'Manually start clocks'
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: bulk-pairings.bulkpairingstartclocks
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: lichess-bulkpairingget
      description: 'Show a bulk pairing'
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: bulk-pairings.bulkpairingget
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: lichess-bulkpairingdelete
      description: 'Cancel a bulk pairing'
      hints:
        readOnly: false
        destructive: true
        idempotent: false
      call: bulk-pairings.bulkpairingdelete
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: lichess-bulkpairingidgamesget
      description: 'Export games of a bulk pairing'
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: bulk-pairings.bulkpairingidgamesget
      with:
        id: tools.id
        moves: tools.moves
        pgnInJson: tools.pgnInJson
        tags: tools.tags
        clocks: tools.clocks
        evals: tools.evals
        accuracy: tools.accuracy
        opening: tools.opening
        division: tools.division
        literate: tools.literate
      outputParameters:
      - type: object
        mapping: $.