CockroachDB Cluster API — Health

naftiko: 1.0.0-alpha2
info:
  label: CockroachDB Cluster API — Health
  description: 'CockroachDB Cluster API — Health. 1 operations. Lead operation: Check node health. Self-contained Naftiko
    capability covering one Cockroachdb business surface.'
  tags:
  - Cockroachdb
  - Health
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COCKROACHDB_API_KEY: COCKROACHDB_API_KEY
capability:
  consumes:
  - type: http
    namespace: cluster-health
    baseUri: https://localhost:8080
    description: CockroachDB Cluster API — Health business capability. Self-contained, no shared references.
    resources:
    - name: api-v2-health
      path: /api/v2/health/
      operations:
      - name: health
        method: GET
        description: Check node health
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: ready
          in: query
          type: boolean
          description: If true, checks whether the node is fully ready to accept SQL connections in addition to being live.
    authentication:
      type: apikey
      key: X-Cockroach-API-Session
      value: '{{env.COCKROACHDB_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: cluster-health-rest
    port: 8080
    description: REST adapter for CockroachDB Cluster API — Health. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/v2/health
      name: api-v2-health
      description: REST surface for api-v2-health.
      operations:
      - method: GET
        name: health
        description: Check node health
        call: cluster-health.health
        with:
          ready: rest.ready
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: cluster-health-mcp
    port: 9090
    transport: http
    description: MCP adapter for CockroachDB Cluster API — Health. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: check-node-health
      description: Check node health
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cluster-health.health
      with:
        ready: tools.ready
      outputParameters:
      - type: object
        mapping: $.