Coveo Search API — Passages V3

naftiko: 1.0.0-alpha2
info:
  label: Coveo Search API — Passages V3
  description: 'Coveo Search API — Passages V3. 1 operations. Lead operation: Retrieves the Passage(s) for a Particular Query..
    Self-contained Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Search
  - Passages V3
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COVEO_SEARCH_TOKEN: COVEO_SEARCH_TOKEN
capability:
  consumes:
  - type: http
    namespace: search-passages-v3
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Search API — Passages V3 business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_SEARCH_TOKEN}}'
    resources:
    - name: rest-search-v3-passages-retrieve
      path: /rest/search/v3/passages/retrieve
      operations:
      - name: retrievepassagev3
        method: POST
        description: Retrieves the Passage(s) for a Particular Query.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
  exposes:
  - type: rest
    namespace: search-passages-v3-rest
    port: 8080
    description: REST adapter for Coveo Search API — Passages V3. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/search/v3/passages/retrieve
      name: rest-search-v3-passages-retrieve
      description: REST surface for rest-search-v3-passages-retrieve.
      operations:
      - method: POST
        name: retrievepassagev3
        description: Retrieves the Passage(s) for a Particular Query.
        call: search-passages-v3.retrievepassagev3
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: search-passages-v3-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Search API — Passages V3. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: retrieves-passage-s-particular-query
      description: Retrieves the Passage(s) for a Particular Query.
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: search-passages-v3.retrievepassagev3
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.