tidb · Capability

TiDB HTTP API — Status

TiDB HTTP API — Status. 4 operations. Lead operation: Get server information. Self-contained Naftiko capability covering one Tidb business surface.

Run with Naftiko TidbStatus

What You Can Do

GET
Getserverinfo — Get server information
/v1/info
GET
Getallserversinfo — Get all cluster server information
/v1/info/all
GET
Getmetrics — Get Prometheus metrics
/v1/metrics
GET
Getserverstatus — Get server status
/v1/status

MCP Tools

get-server-information

Get server information

read-only idempotent
get-all-cluster-server-information

Get all cluster server information

read-only idempotent
get-prometheus-metrics

Get Prometheus metrics

read-only idempotent
get-server-status

Get server status

read-only idempotent

Capability Spec

http-status.yaml Raw ↑
naftiko: 1.0.0-alpha2
info:
  label: TiDB HTTP API — Status
  description: 'TiDB HTTP API — Status. 4 operations. Lead operation: Get server information. Self-contained Naftiko capability
    covering one Tidb business surface.'
  tags:
  - Tidb
  - Status
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TIDB_API_KEY: TIDB_API_KEY
capability:
  consumes:
  - type: http
    namespace: http-status
    baseUri: http://localhost:10080
    description: TiDB HTTP API — Status business capability. Self-contained, no shared references.
    resources:
    - name: info
      path: /info
      operations:
      - name: getserverinfo
        method: GET
        description: Get server information
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: info-all
      path: /info/all
      operations:
      - name: getallserversinfo
        method: GET
        description: Get all cluster server information
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: metrics
      path: /metrics
      operations:
      - name: getmetrics
        method: GET
        description: Get Prometheus metrics
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: status
      path: /status
      operations:
      - name: getserverstatus
        method: GET
        description: Get server status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    namespace: http-status-rest
    port: 8080
    description: REST adapter for TiDB HTTP API — Status. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/info
      name: info
      description: REST surface for info.
      operations:
      - method: GET
        name: getserverinfo
        description: Get server information
        call: http-status.getserverinfo
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/info/all
      name: info-all
      description: REST surface for info-all.
      operations:
      - method: GET
        name: getallserversinfo
        description: Get all cluster server information
        call: http-status.getallserversinfo
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/metrics
      name: metrics
      description: REST surface for metrics.
      operations:
      - method: GET
        name: getmetrics
        description: Get Prometheus metrics
        call: http-status.getmetrics
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/status
      name: status
      description: REST surface for status.
      operations:
      - method: GET
        name: getserverstatus
        description: Get server status
        call: http-status.getserverstatus
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: http-status-mcp
    port: 9090
    transport: http
    description: MCP adapter for TiDB HTTP API — Status. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: get-server-information
      description: Get server information
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: http-status.getserverinfo
      outputParameters:
      - type: object
        mapping: $.
    - name: get-all-cluster-server-information
      description: Get all cluster server information
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: http-status.getallserversinfo
      outputParameters:
      - type: object
        mapping: $.
    - name: get-prometheus-metrics
      description: Get Prometheus metrics
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: http-status.getmetrics
      outputParameters:
      - type: object
        mapping: $.
    - name: get-server-status
      description: Get server status
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: http-status.getserverstatus
      outputParameters:
      - type: object
        mapping: $.