Coveo Search API — Analysis V3

naftiko: 1.0.0-alpha2
info:
  label: Coveo Search API — Analysis V3
  description: 'Coveo Search API — Analysis V3. 2 operations. Lead operation: Convert Query to Structured Expression. Self-contained
    Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Search
  - Analysis 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-analysis-v3
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Search API — Analysis V3 business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_SEARCH_TOKEN}}'
    resources:
    - name: rest-search-v3-analysis-expressions-structured
      path: /rest/search/v3/analysis/expressions/structured
      operations:
      - name: parseexpressiontostructured
        method: POST
        description: Convert Query to Structured Expression
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-search-v3-analysis-inspect-replay
      path: /rest/search/v3/analysis/inspect/replay
      operations:
      - name: replay
        method: POST
        description: Replay a Query with Inspection Details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
  exposes:
  - type: rest
    namespace: search-analysis-v3-rest
    port: 8080
    description: REST adapter for Coveo Search API — Analysis V3. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/search/v3/analysis/expressions/structured
      name: rest-search-v3-analysis-expressions-structured
      description: REST surface for rest-search-v3-analysis-expressions-structured.
      operations:
      - method: POST
        name: parseexpressiontostructured
        description: Convert Query to Structured Expression
        call: search-analysis-v3.parseexpressiontostructured
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/search/v3/analysis/inspect/replay
      name: rest-search-v3-analysis-inspect-replay
      description: REST surface for rest-search-v3-analysis-inspect-replay.
      operations:
      - method: POST
        name: replay
        description: Replay a Query with Inspection Details
        call: search-analysis-v3.replay
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: search-analysis-v3-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Search API — Analysis V3. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: convert-query-structured-expression
      description: Convert Query to Structured Expression
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: search-analysis-v3.parseexpressiontostructured
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: replay-query-inspection-details
      description: Replay a Query with Inspection Details
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: search-analysis-v3.replay
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.