Microsoft Azure Form Recognizer Client — Prebuilt

naftiko: 1.0.0-alpha2
info:
  label: Microsoft Azure Form Recognizer Client — Prebuilt
  description: 'Microsoft Azure Form Recognizer Client — Prebuilt. 8 operations. Lead operation: Microsoft Azure Analyze Business
    Card. Self-contained Naftiko capability covering one Microsoft Azure business surface.'
  tags:
  - Microsoft Azure
  - Prebuilt
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    MICROSOFT_AZURE_API_KEY: MICROSOFT_AZURE_API_KEY
capability:
  consumes:
  - type: http
    namespace: form-recognizer-client-prebuilt
    baseUri: ''
    description: Microsoft Azure Form Recognizer Client — Prebuilt business capability. Self-contained, no shared references.
    resources:
    - name: prebuilt-businessCard-analyze
      path: /prebuilt/businessCard/analyze
      operations:
      - name: microsoftazureanalyzebusinesscardasync
        method: POST
        description: Microsoft Azure Analyze Business Card
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: includeTextDetails
          in: query
          type: boolean
          description: Include text lines and element references in the result.
    - name: prebuilt-businessCard-analyzeResults-resultId
      path: /prebuilt/businessCard/analyzeResults/{resultId}
      operations:
      - name: microsoftazuregetanalyzebusinesscardresult
        method: GET
        description: Microsoft Azure Get Analyze Business Card Result
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: resultId
          in: path
          type: string
          description: Analyze operation result identifier.
          required: true
    - name: prebuilt-idDocument-analyze
      path: /prebuilt/idDocument/analyze
      operations:
      - name: microsoftazureanalyzeiddocumentasync
        method: POST
        description: Microsoft Azure Analyze Id Document
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: includeTextDetails
          in: query
          type: boolean
          description: Include text lines and element references in the result.
    - name: prebuilt-idDocument-analyzeResults-resultId
      path: /prebuilt/idDocument/analyzeResults/{resultId}
      operations:
      - name: microsoftazuregetanalyzeiddocumentresult
        method: GET
        description: Microsoft Azure Get Analyze Id Document Result
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: resultId
          in: path
          type: string
          description: Analyze operation result identifier.
          required: true
    - name: prebuilt-invoice-analyze
      path: /prebuilt/invoice/analyze
      operations:
      - name: microsoftazureanalyzeinvoiceasync
        method: POST
        description: Microsoft Azure Analyze Invoice Document
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: includeTextDetails
          in: query
          type: boolean
          description: Include text lines and element references in the result.
    - name: prebuilt-invoice-analyzeResults-resultId
      path: /prebuilt/invoice/analyzeResults/{resultId}
      operations:
      - name: microsoftazuregetanalyzeinvoiceresult
        method: GET
        description: Microsoft Azure Get Analyze Invoice Result
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: resultId
          in: path
          type: string
          description: Analyze operation result identifier.
          required: true
    - name: prebuilt-receipt-analyze
      path: /prebuilt/receipt/analyze
      operations:
      - name: microsoftazureanalyzereceiptasync
        method: POST
        description: Microsoft Azure Analyze Receipt
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: includeTextDetails
          in: query
          type: boolean
          description: Include text lines and element references in the result.
    - name: prebuilt-receipt-analyzeResults-resultId
      path: /prebuilt/receipt/analyzeResults/{resultId}
      operations:
      - name: microsoftazuregetanalyzereceiptresult
        method: GET
        description: Microsoft Azure Get Analyze Receipt Result
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: resultId
          in: path
          type: string
          description: Analyze operation result identifier.
          required: true
  exposes:
  - type: rest
    namespace: form-recognizer-client-prebuilt-rest
    port: 8080
    description: REST adapter for Microsoft Azure Form Recognizer Client — Prebuilt. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/prebuilt/businesscard/analyze
      name: prebuilt-businesscard-analyze
      description: REST surface for prebuilt-businessCard-analyze.
      operations:
      - method: POST
        name: microsoftazureanalyzebusinesscardasync
        description: Microsoft Azure Analyze Business Card
        call: form-recognizer-client-prebuilt.microsoftazureanalyzebusinesscardasync
        with:
          includeTextDetails: rest.includeTextDetails
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/prebuilt/businesscard/analyzeresults/{resultid}
      name: prebuilt-businesscard-analyzeresults-resultid
      description: REST surface for prebuilt-businessCard-analyzeResults-resultId.
      operations:
      - method: GET
        name: microsoftazuregetanalyzebusinesscardresult
        description: Microsoft Azure Get Analyze Business Card Result
        call: form-recognizer-client-prebuilt.microsoftazuregetanalyzebusinesscardresult
        with:
          resultId: rest.resultId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/prebuilt/iddocument/analyze
      name: prebuilt-iddocument-analyze
      description: REST surface for prebuilt-idDocument-analyze.
      operations:
      - method: POST
        name: microsoftazureanalyzeiddocumentasync
        description: Microsoft Azure Analyze Id Document
        call: form-recognizer-client-prebuilt.microsoftazureanalyzeiddocumentasync
        with:
          includeTextDetails: rest.includeTextDetails
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/prebuilt/iddocument/analyzeresults/{resultid}
      name: prebuilt-iddocument-analyzeresults-resultid
      description: REST surface for prebuilt-idDocument-analyzeResults-resultId.
      operations:
      - method: GET
        name: microsoftazuregetanalyzeiddocumentresult
        description: Microsoft Azure Get Analyze Id Document Result
        call: form-recognizer-client-prebuilt.microsoftazuregetanalyzeiddocumentresult
        with:
          resultId: rest.resultId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/prebuilt/invoice/analyze
      name: prebuilt-invoice-analyze
      description: REST surface for prebuilt-invoice-analyze.
      operations:
      - method: POST
        name: microsoftazureanalyzeinvoiceasync
        description: Microsoft Azure Analyze Invoice Document
        call: form-recognizer-client-prebuilt.microsoftazureanalyzeinvoiceasync
        with:
          includeTextDetails: rest.includeTextDetails
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/prebuilt/invoice/analyzeresults/{resultid}
      name: prebuilt-invoice-analyzeresults-resultid
      description: REST surface for prebuilt-invoice-analyzeResults-resultId.
      operations:
      - method: GET
        name: microsoftazuregetanalyzeinvoiceresult
        description: Microsoft Azure Get Analyze Invoice Result
        call: form-recognizer-client-prebuilt.microsoftazuregetanalyzeinvoiceresult
        with:
          resultId: rest.resultId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/prebuilt/receipt/analyze
      name: prebuilt-receipt-analyze
      description: REST surface for prebuilt-receipt-analyze.
      operations:
      - method: POST
        name: microsoftazureanalyzereceiptasync
        description: Microsoft Azure Analyze Receipt
        call: form-recognizer-client-prebuilt.microsoftazureanalyzereceiptasync
        with:
          includeTextDetails: rest.includeTextDetails
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/prebuilt/receipt/analyzeresults/{resultid}
      name: prebuilt-receipt-analyzeresults-resultid
      description: REST surface for prebuilt-receipt-analyzeResults-resultId.
      operations:
      - method: GET
        name: microsoftazuregetanalyzereceiptresult
        description: Microsoft Azure Get Analyze Receipt Result
        call: form-recognizer-client-prebuilt.microsoftazuregetanalyzereceiptresult
        with:
          resultId: rest.resultId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: form-recognizer-client-prebuilt-mcp
    port: 9090
    transport: http
    description: MCP adapter for Microsoft Azure Form Recognizer Client — Prebuilt. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: microsoft-azure-analyze-business-card
      description: Microsoft Azure Analyze Business Card
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: form-recognizer-client-prebuilt.microsoftazureanalyzebusinesscardasync
      with:
        includeTextDetails: tools.includeTextDetails
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-get-analyze-business
      description: Microsoft Azure Get Analyze Business Card Result
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: form-recognizer-client-prebuilt.microsoftazuregetanalyzebusinesscardresult
      with:
        resultId: tools.resultId
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-analyze-id-document
      description: Microsoft Azure Analyze Id Document
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: form-recognizer-client-prebuilt.microsoftazureanalyzeiddocumentasync
      with:
        includeTextDetails: tools.includeTextDetails
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-get-analyze-id
      description: Microsoft Azure Get Analyze Id Document Result
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: form-recognizer-client-prebuilt.microsoftazuregetanalyzeiddocumentresult
      with:
        resultId: tools.resultId
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-analyze-invoice-document
      description: Microsoft Azure Analyze Invoice Document
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: form-recognizer-client-prebuilt.microsoftazureanalyzeinvoiceasync
      with:
        includeTextDetails: tools.includeTextDetails
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-get-analyze-invoice
      description: Microsoft Azure Get Analyze Invoice Result
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: form-recognizer-client-prebuilt.microsoftazuregetanalyzeinvoiceresult
      with:
        resultId: tools.resultId
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-analyze-receipt
      description: Microsoft Azure Analyze Receipt
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: form-recognizer-client-prebuilt.microsoftazureanalyzereceiptasync
      with:
        includeTextDetails: tools.includeTextDetails
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-get-analyze-receipt
      description: Microsoft Azure Get Analyze Receipt Result
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: form-recognizer-client-prebuilt.microsoftazuregetanalyzereceiptresult
      with:
        resultId: tools.resultId
      outputParameters:
      - type: object
        mapping: $.