TiDB Cloud API — Imports

naftiko: 1.0.0-alpha2
info:
  label: TiDB Cloud API — Imports
  description: 'TiDB Cloud API — Imports. 4 operations. Lead operation: List import tasks. Self-contained Naftiko capability
    covering one Tidb business surface.'
  tags:
  - Tidb
  - Imports
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TIDB_API_KEY: TIDB_API_KEY
capability:
  consumes:
  - type: http
    namespace: cloud-imports
    baseUri: https://dedicated.tidbapi.com/v1beta1
    description: TiDB Cloud API — Imports business capability. Self-contained, no shared references.
    resources:
    - name: clusters-clusterId-imports
      path: /clusters/{clusterId}/imports
      operations:
      - name: listimports
        method: GET
        description: List import tasks
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createimport
        method: POST
        description: Create an import task
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: clusters-clusterId-imports-importId
      path: /clusters/{clusterId}/imports/{importId}
      operations:
      - name: getimport
        method: GET
        description: Get an import task
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: clusters-clusterId-imports-importId}:cancel
      path: /clusters/{clusterId}/imports/{importId}:cancel
      operations:
      - name: cancelimport
        method: POST
        description: Cancel an import task
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    namespace: cloud-imports-rest
    port: 8080
    description: REST adapter for TiDB Cloud API — Imports. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/clusters/{clusterid}/imports
      name: clusters-clusterid-imports
      description: REST surface for clusters-clusterId-imports.
      operations:
      - method: GET
        name: listimports
        description: List import tasks
        call: cloud-imports.listimports
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createimport
        description: Create an import task
        call: cloud-imports.createimport
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/clusters/{clusterid}/imports/{importid}
      name: clusters-clusterid-imports-importid
      description: REST surface for clusters-clusterId-imports-importId.
      operations:
      - method: GET
        name: getimport
        description: Get an import task
        call: cloud-imports.getimport
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/clusters/{clusterid}/imports/importid-cancel
      name: clusters-clusterid-imports-importid-cancel
      description: REST surface for clusters-clusterId-imports-importId}:cancel.
      operations:
      - method: POST
        name: cancelimport
        description: Cancel an import task
        call: cloud-imports.cancelimport
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: cloud-imports-mcp
    port: 9090
    transport: http
    description: MCP adapter for TiDB Cloud API — Imports. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-import-tasks
      description: List import tasks
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cloud-imports.listimports
      outputParameters:
      - type: object
        mapping: $.
    - name: create-import-task
      description: Create an import task
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: cloud-imports.createimport
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-import-task
      description: Get an import task
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cloud-imports.getimport
      outputParameters:
      - type: object
        mapping: $.
    - name: cancel-import-task
      description: Cancel an import task
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: cloud-imports.cancelimport
      outputParameters:
      - type: object
        mapping: $.