PlanetScale Platform API — Databases

naftiko: 1.0.0-alpha2
info:
  label: PlanetScale Platform API — Databases
  description: 'PlanetScale Platform API — Databases. 5 operations. Lead operation: List databases. Self-contained Naftiko
    capability covering one Planetscale business surface.'
  tags:
  - Planetscale
  - Databases
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PLANETSCALE_API_KEY: PLANETSCALE_API_KEY
capability:
  consumes:
  - type: http
    namespace: platform-databases
    baseUri: https://api.planetscale.com/v1
    description: PlanetScale Platform API — Databases business capability. Self-contained, no shared references.
    resources:
    - name: organizations-organization-databases
      path: /organizations/{organization}/databases
      operations:
      - name: listdatabases
        method: GET
        description: List databases
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createdatabase
        method: POST
        description: Create a database
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: organizations-organization-databases-database
      path: /organizations/{organization}/databases/{database}
      operations:
      - name: getdatabase
        method: GET
        description: Get a database
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatedatabasesettings
        method: PATCH
        description: Update database settings
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletedatabase
        method: DELETE
        description: Delete a database
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.PLANETSCALE_API_KEY}}'
  exposes:
  - type: rest
    namespace: platform-databases-rest
    port: 8080
    description: REST adapter for PlanetScale Platform API — Databases. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/organizations/{organization}/databases
      name: organizations-organization-databases
      description: REST surface for organizations-organization-databases.
      operations:
      - method: GET
        name: listdatabases
        description: List databases
        call: platform-databases.listdatabases
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createdatabase
        description: Create a database
        call: platform-databases.createdatabase
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organization}/databases/{database}
      name: organizations-organization-databases-database
      description: REST surface for organizations-organization-databases-database.
      operations:
      - method: GET
        name: getdatabase
        description: Get a database
        call: platform-databases.getdatabase
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatedatabasesettings
        description: Update database settings
        call: platform-databases.updatedatabasesettings
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletedatabase
        description: Delete a database
        call: platform-databases.deletedatabase
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: platform-databases-mcp
    port: 9090
    transport: http
    description: MCP adapter for PlanetScale Platform API — Databases. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-databases
      description: List databases
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-databases.listdatabases
      outputParameters:
      - type: object
        mapping: $.
    - name: create-database
      description: Create a database
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: platform-databases.createdatabase
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-database
      description: Get a database
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-databases.getdatabase
      outputParameters:
      - type: object
        mapping: $.
    - name: update-database-settings
      description: Update database settings
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: platform-databases.updatedatabasesettings
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-database
      description: Delete a database
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: platform-databases.deletedatabase
      outputParameters:
      - type: object
        mapping: $.