VTex Intelligent Search API — Autocomplete

naftiko: 1.0.0-alpha2
info:
  label: VTex Intelligent Search API — Autocomplete
  description: 'VTex Intelligent Search API — Autocomplete. 3 operations. Lead operation: VTex Get list of suggested terms
    and attributes similar to the search term. Self-contained Naftiko capability covering one Vtex business surface.'
  tags:
  - Vtex
  - Autocomplete
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    VTEX_API_KEY: VTEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: intelligent-search-autocomplete
    baseUri: https://{accountName}.{environment}.com.br/api/io/_v/api/intelligent-search
    description: VTex Intelligent Search API — Autocomplete business capability. Self-contained, no shared references.
    resources:
    - name: autocomplete_suggestions
      path: /autocomplete_suggestions
      operations:
      - name: get
        method: GET
        description: VTex Get list of suggested terms and attributes similar to the search term
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: search_suggestions
      path: /search_suggestions
      operations:
      - name: get
        method: GET
        description: VTex Get list of suggested terms similar to the search term
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: top_searches
      path: /top_searches
      operations:
      - name: get
        method: GET
        description: VTex Get list of the 10 most searched terms
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    namespace: intelligent-search-autocomplete-rest
    port: 8080
    description: REST adapter for VTex Intelligent Search API — Autocomplete. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/autocomplete-suggestions
      name: autocomplete-suggestions
      description: REST surface for autocomplete_suggestions.
      operations:
      - method: GET
        name: get
        description: VTex Get list of suggested terms and attributes similar to the search term
        call: intelligent-search-autocomplete.get
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/search-suggestions
      name: search-suggestions
      description: REST surface for search_suggestions.
      operations:
      - method: GET
        name: get
        description: VTex Get list of suggested terms similar to the search term
        call: intelligent-search-autocomplete.get
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/top-searches
      name: top-searches
      description: REST surface for top_searches.
      operations:
      - method: GET
        name: get
        description: VTex Get list of the 10 most searched terms
        call: intelligent-search-autocomplete.get
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: intelligent-search-autocomplete-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Intelligent Search API — Autocomplete. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: vtex-get-list-suggested-terms
      description: VTex Get list of suggested terms and attributes similar to the search term
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: intelligent-search-autocomplete.get
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-get-list-suggested-terms-2
      description: VTex Get list of suggested terms similar to the search term
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: intelligent-search-autocomplete.get
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-get-list-10-most
      description: VTex Get list of the 10 most searched terms
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: intelligent-search-autocomplete.get
      outputParameters:
      - type: object
        mapping: $.