TiDB Cloud Chat2Query API — Data Summaries

naftiko: 1.0.0-alpha2
info:
  label: TiDB Cloud Chat2Query API — Data Summaries
  description: 'TiDB Cloud Chat2Query API — Data Summaries. 5 operations. Lead operation: Create a data summary (v2). Self-contained
    Naftiko capability covering one Tidb business surface.'
  tags:
  - Tidb
  - Data Summaries
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TIDB_API_KEY: TIDB_API_KEY
capability:
  consumes:
  - type: http
    namespace: cloud-chat2query-data-summaries
    baseUri: https://data.tidbcloud.com/api/v1beta/app/{dataAppId}/endpoint
    description: TiDB Cloud Chat2Query API — Data Summaries business capability. Self-contained, no shared references.
    resources:
    - name: v2-dataSummaries
      path: /v2/dataSummaries
      operations:
      - name: createdatasummaryv2
        method: POST
        description: Create a data summary (v2)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v3-dataSummaries
      path: /v3/dataSummaries
      operations:
      - name: listdatasummaries
        method: GET
        description: List data summaries
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createdatasummary
        method: POST
        description: Create a data summary
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v3-dataSummaries-data_summary_id
      path: /v3/dataSummaries/{data_summary_id}
      operations:
      - name: getdatasummary
        method: GET
        description: Get a data summary
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatedatasummary
        method: PUT
        description: Update a data summary
        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-chat2query-data-summaries-rest
    port: 8080
    description: REST adapter for TiDB Cloud Chat2Query API — Data Summaries. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/v2/datasummaries
      name: v2-datasummaries
      description: REST surface for v2-dataSummaries.
      operations:
      - method: POST
        name: createdatasummaryv2
        description: Create a data summary (v2)
        call: cloud-chat2query-data-summaries.createdatasummaryv2
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/datasummaries
      name: v3-datasummaries
      description: REST surface for v3-dataSummaries.
      operations:
      - method: GET
        name: listdatasummaries
        description: List data summaries
        call: cloud-chat2query-data-summaries.listdatasummaries
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createdatasummary
        description: Create a data summary
        call: cloud-chat2query-data-summaries.createdatasummary
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/datasummaries/{data-summary-id}
      name: v3-datasummaries-data-summary-id
      description: REST surface for v3-dataSummaries-data_summary_id.
      operations:
      - method: GET
        name: getdatasummary
        description: Get a data summary
        call: cloud-chat2query-data-summaries.getdatasummary
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatedatasummary
        description: Update a data summary
        call: cloud-chat2query-data-summaries.updatedatasummary
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: cloud-chat2query-data-summaries-mcp
    port: 9090
    transport: http
    description: MCP adapter for TiDB Cloud Chat2Query API — Data Summaries. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: create-data-summary-v2
      description: Create a data summary (v2)
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: cloud-chat2query-data-summaries.createdatasummaryv2
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-data-summaries
      description: List data summaries
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cloud-chat2query-data-summaries.listdatasummaries
      outputParameters:
      - type: object
        mapping: $.
    - name: create-data-summary
      description: Create a data summary
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: cloud-chat2query-data-summaries.createdatasummary
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-data-summary
      description: Get a data summary
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cloud-chat2query-data-summaries.getdatasummary
      outputParameters:
      - type: object
        mapping: $.
    - name: update-data-summary
      description: Update a data summary
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: cloud-chat2query-data-summaries.updatedatasummary
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.