VTex Master Data API - v2 — Search

naftiko: 1.0.0-alpha2
info:
  label: VTex Master Data API - v2 — Search
  description: 'VTex Master Data API - v2 — Search. 1 operations. Lead operation: VTex Search documents. Self-contained Naftiko
    capability covering one Vtex business surface.'
  tags:
  - Vtex
  - Search
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    VTEX_API_KEY: VTEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: master-data-search
    baseUri: https://{accountName}.{environment}.com.br
    description: VTex Master Data API - v2 — Search business capability. Self-contained, no shared references.
    resources:
    - name: api-dataentities-dataEntityName-search
      path: /api/dataentities/{dataEntityName}/search
      operations:
      - name: searchdocuments
        method: GET
        description: VTex Search documents
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: X-VTEX-API-AppKey
      value: '{{env.VTEX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: master-data-search-rest
    port: 8080
    description: REST adapter for VTex Master Data API - v2 — Search. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/dataentities/{dataentityname}/search
      name: api-dataentities-dataentityname-search
      description: REST surface for api-dataentities-dataEntityName-search.
      operations:
      - method: GET
        name: searchdocuments
        description: VTex Search documents
        call: master-data-search.searchdocuments
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: master-data-search-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Master Data API - v2 — Search. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: vtex-search-documents
      description: VTex Search documents
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: master-data-search.searchdocuments
      outputParameters:
      - type: object
        mapping: $.