KServe Open Inference Protocol API — Health

naftiko: 1.0.0-alpha2
info:
  label: KServe Open Inference Protocol API — Health
  description: 'KServe Open Inference Protocol API — Health. 4 operations. Lead operation: Check Server Liveness. Self-contained
    Naftiko capability covering one Scalable Inference Serving business surface.'
  tags:
  - Scalable Inference Serving
  - Health
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SCALABLE_INFERENCE_SERVING_API_KEY: SCALABLE_INFERENCE_SERVING_API_KEY
capability:
  consumes:
  - type: http
    namespace: kserve-open-inference-protocol-health
    baseUri: https://inference.kserve.example.com
    description: KServe Open Inference Protocol API — Health business capability. Self-contained, no shared references.
    resources:
    - name: v2-health-live
      path: /v2/health/live
      operations:
      - name: checkserverliveness
        method: GET
        description: Check Server Liveness
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v2-health-ready
      path: /v2/health/ready
      operations:
      - name: checkserverreadiness
        method: GET
        description: Check Server Readiness
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v2-models-model_name-ready
      path: /v2/models/{model_name}/ready
      operations:
      - name: checkmodelreadiness
        method: GET
        description: Check Model Readiness
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: model_name
          in: path
          type: string
          description: Name of the model to check readiness for.
          required: true
    - name: v2-models-model_name-versions-model_version-ready
      path: /v2/models/{model_name}/versions/{model_version}/ready
      operations:
      - name: checkmodelversionreadiness
        method: GET
        description: Check Model Version Readiness
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: model_name
          in: path
          type: string
          required: true
        - name: model_version
          in: path
          type: string
          required: true
  exposes:
  - type: rest
    namespace: kserve-open-inference-protocol-health-rest
    port: 8080
    description: REST adapter for KServe Open Inference Protocol API — Health. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/v2/health/live
      name: v2-health-live
      description: REST surface for v2-health-live.
      operations:
      - method: GET
        name: checkserverliveness
        description: Check Server Liveness
        call: kserve-open-inference-protocol-health.checkserverliveness
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v2/health/ready
      name: v2-health-ready
      description: REST surface for v2-health-ready.
      operations:
      - method: GET
        name: checkserverreadiness
        description: Check Server Readiness
        call: kserve-open-inference-protocol-health.checkserverreadiness
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v2/models/{model-name}/ready
      name: v2-models-model-name-ready
      description: REST surface for v2-models-model_name-ready.
      operations:
      - method: GET
        name: checkmodelreadiness
        description: Check Model Readiness
        call: kserve-open-inference-protocol-health.checkmodelreadiness
        with:
          model_name: rest.model_name
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v2/models/{model-name}/versions/{model-version}/ready
      name: v2-models-model-name-versions-model-version-ready
      description: REST surface for v2-models-model_name-versions-model_version-ready.
      operations:
      - method: GET
        name: checkmodelversionreadiness
        description: Check Model Version Readiness
        call: kserve-open-inference-protocol-health.checkmodelversionreadiness
        with:
          model_name: rest.model_name
          model_version: rest.model_version
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: kserve-open-inference-protocol-health-mcp
    port: 9090
    transport: http
    description: MCP adapter for KServe Open Inference Protocol API — Health. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: check-server-liveness
      description: Check Server Liveness
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: kserve-open-inference-protocol-health.checkserverliveness
      outputParameters:
      - type: object
        mapping: $.
    - name: check-server-readiness
      description: Check Server Readiness
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: kserve-open-inference-protocol-health.checkserverreadiness
      outputParameters:
      - type: object
        mapping: $.
    - name: check-model-readiness
      description: Check Model Readiness
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: kserve-open-inference-protocol-health.checkmodelreadiness
      with:
        model_name: tools.model_name
      outputParameters:
      - type: object
        mapping: $.
    - name: check-model-version-readiness
      description: Check Model Version Readiness
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: kserve-open-inference-protocol-health.checkmodelversionreadiness
      with:
        model_name: tools.model_name
        model_version: tools.model_version
      outputParameters:
      - type: object
        mapping: $.