Chroma · Capability

Chroma Server API — System

Chroma Server API — System. 5 operations. Lead operation: Check server health. Self-contained Naftiko capability covering one Chroma business surface.

Run with Naftiko ChromaSystem

What You Can Do

GET
Healthcheck — Check server health
/v1/api/v2/healthcheck
GET
Heartbeat — Check server heartbeat
/v1/api/v2/heartbeat
GET
Preflightchecks — Run pre-flight checks
/v1/api/v2/pre-flight-checks
POST
Reset — Reset the server
/v1/api/v2/reset
GET
Getversion — Get server version
/v1/api/v2/version

MCP Tools

check-server-health

Check server health

read-only idempotent
check-server-heartbeat

Check server heartbeat

read-only idempotent
run-pre-flight-checks

Run pre-flight checks

read-only idempotent
reset-server

Reset the server

get-server-version

Get server version

read-only idempotent

Capability Spec

server-system.yaml Raw ↑
naftiko: 1.0.0-alpha2
info:
  label: Chroma Server API — System
  description: 'Chroma Server API — System. 5 operations. Lead operation: Check server health. Self-contained Naftiko capability
    covering one Chroma business surface.'
  tags:
  - Chroma
  - System
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    CHROMA_API_KEY: CHROMA_API_KEY
capability:
  consumes:
  - type: http
    namespace: server-system
    baseUri: http://localhost:8000
    description: Chroma Server API — System business capability. Self-contained, no shared references.
    resources:
    - name: api-v2-healthcheck
      path: /api/v2/healthcheck
      operations:
      - name: healthcheck
        method: GET
        description: Check server health
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-v2-heartbeat
      path: /api/v2/heartbeat
      operations:
      - name: heartbeat
        method: GET
        description: Check server heartbeat
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-v2-pre-flight-checks
      path: /api/v2/pre-flight-checks
      operations:
      - name: preflightchecks
        method: GET
        description: Run pre-flight checks
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-v2-reset
      path: /api/v2/reset
      operations:
      - name: reset
        method: POST
        description: Reset the server
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-v2-version
      path: /api/v2/version
      operations:
      - name: getversion
        method: GET
        description: Get server version
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.CHROMA_API_KEY}}'
  exposes:
  - type: rest
    namespace: server-system-rest
    port: 8080
    description: REST adapter for Chroma Server API — System. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/api/v2/healthcheck
      name: api-v2-healthcheck
      description: REST surface for api-v2-healthcheck.
      operations:
      - method: GET
        name: healthcheck
        description: Check server health
        call: server-system.healthcheck
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v2/heartbeat
      name: api-v2-heartbeat
      description: REST surface for api-v2-heartbeat.
      operations:
      - method: GET
        name: heartbeat
        description: Check server heartbeat
        call: server-system.heartbeat
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v2/pre-flight-checks
      name: api-v2-pre-flight-checks
      description: REST surface for api-v2-pre-flight-checks.
      operations:
      - method: GET
        name: preflightchecks
        description: Run pre-flight checks
        call: server-system.preflightchecks
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v2/reset
      name: api-v2-reset
      description: REST surface for api-v2-reset.
      operations:
      - method: POST
        name: reset
        description: Reset the server
        call: server-system.reset
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v2/version
      name: api-v2-version
      description: REST surface for api-v2-version.
      operations:
      - method: GET
        name: getversion
        description: Get server version
        call: server-system.getversion
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: server-system-mcp
    port: 9090
    transport: http
    description: MCP adapter for Chroma Server API — System. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: check-server-health
      description: Check server health
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: server-system.healthcheck
      outputParameters:
      - type: object
        mapping: $.
    - name: check-server-heartbeat
      description: Check server heartbeat
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: server-system.heartbeat
      outputParameters:
      - type: object
        mapping: $.
    - name: run-pre-flight-checks
      description: Run pre-flight checks
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: server-system.preflightchecks
      outputParameters:
      - type: object
        mapping: $.
    - name: reset-server
      description: Reset the server
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: server-system.reset
      outputParameters:
      - type: object
        mapping: $.
    - name: get-server-version
      description: Get server version
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: server-system.getversion
      outputParameters:
      - type: object
        mapping: $.