tidb · Capability

TiDB Cloud Data Service API — Data App API Keys

TiDB Cloud Data Service API — Data App API Keys. 2 operations. Lead operation: List Data App API keys. Self-contained Naftiko capability covering one Tidb business surface.

Run with Naftiko TidbData App API Keys

What You Can Do

GET
Listdataappapikeys — List Data App API keys
/v1/dataapps/{dataappid}/apikeys
POST
Createdataappapikey — Create a Data App API key
/v1/dataapps/{dataappid}/apikeys

MCP Tools

list-data-app-api-keys

List Data App API keys

read-only idempotent
create-data-app-api-key

Create a Data App API key

Capability Spec

cloud-data-service-data-app-api-keys.yaml Raw ↑
naftiko: 1.0.0-alpha2
info:
  label: TiDB Cloud Data Service API — Data App API Keys
  description: 'TiDB Cloud Data Service API — Data App API Keys. 2 operations. Lead operation: List Data App API keys. Self-contained
    Naftiko capability covering one Tidb business surface.'
  tags:
  - Tidb
  - Data App API Keys
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TIDB_API_KEY: TIDB_API_KEY
capability:
  consumes:
  - type: http
    namespace: cloud-data-service-data-app-api-keys
    baseUri: https://dataservice.tidbapi.com/v1beta1
    description: TiDB Cloud Data Service API — Data App API Keys business capability. Self-contained, no shared references.
    resources:
    - name: dataApps-dataAppId-apiKeys
      path: /dataApps/{dataAppId}/apiKeys
      operations:
      - name: listdataappapikeys
        method: GET
        description: List Data App API keys
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createdataappapikey
        method: POST
        description: Create a Data App API key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
  exposes:
  - type: rest
    namespace: cloud-data-service-data-app-api-keys-rest
    port: 8080
    description: REST adapter for TiDB Cloud Data Service API — Data App API Keys. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/dataapps/{dataappid}/apikeys
      name: dataapps-dataappid-apikeys
      description: REST surface for dataApps-dataAppId-apiKeys.
      operations:
      - method: GET
        name: listdataappapikeys
        description: List Data App API keys
        call: cloud-data-service-data-app-api-keys.listdataappapikeys
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createdataappapikey
        description: Create a Data App API key
        call: cloud-data-service-data-app-api-keys.createdataappapikey
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: cloud-data-service-data-app-api-keys-mcp
    port: 9090
    transport: http
    description: MCP adapter for TiDB Cloud Data Service API — Data App API Keys. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: list-data-app-api-keys
      description: List Data App API keys
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cloud-data-service-data-app-api-keys.listdataappapikeys
      outputParameters:
      - type: object
        mapping: $.
    - name: create-data-app-api-key
      description: Create a Data App API key
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: cloud-data-service-data-app-api-keys.createdataappapikey
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.