TheGamesDB API — Platforms

naftiko: 1.0.0-alpha2
info:
  label: TheGamesDB API — Platforms
  description: 'TheGamesDB API — Platforms. 4 operations. Lead operation: Fetch platforms list. Self-contained Naftiko capability
    covering one Thegamesdb business surface.'
  tags:
  - Thegamesdb
  - Platforms
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    THEGAMESDB_API_KEY: THEGAMESDB_API_KEY
capability:
  consumes:
  - type: http
    namespace: thegamesdb-platforms
    baseUri: https://api.thegamesdb.net
    description: TheGamesDB API — Platforms business capability. Self-contained, no shared references.
    resources:
    - name: v1-Platforms
      path: /v1/Platforms
      operations:
      - name: platforms
        method: GET
        description: Fetch platforms list
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: apikey
          in: query
          type: string
          description: (Required)
          required: true
        - name: fields
          in: query
          type: string
          description: '(Optional) - valid `,` delimited options: `icon`, `console`, `controller`, `developer`, `manufacturer`,
            `media`, `cpu`, `memory`, `graphics`, `sound`, `maxcontr'
    - name: v1-Platforms-ByPlatformID
      path: /v1/Platforms/ByPlatformID
      operations:
      - name: platformsbyplatformid
        method: GET
        description: Fetch platforms list by id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: apikey
          in: query
          type: string
          description: (Required)
          required: true
        - name: id
          in: query
          type: integer
          description: (Required) - supports `,` delimited list
          required: true
        - name: fields
          in: query
          type: string
          description: '(Optional) - valid `,` delimited options: `icon`, `console`, `controller`, `developer`, `manufacturer`,
            `media`, `cpu`, `memory`, `graphics`, `sound`, `maxcontr'
    - name: v1-Platforms-ByPlatformName
      path: /v1/Platforms/ByPlatformName
      operations:
      - name: platformsbyplatformname
        method: GET
        description: Fetch platforms by name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: apikey
          in: query
          type: string
          description: (Required)
          required: true
        - name: name
          in: query
          type: string
          description: (Required)
          required: true
        - name: fields
          in: query
          type: string
          description: '(Optional) - valid `,` delimited options: `icon`, `console`, `controller`, `developer`, `manufacturer`,
            `media`, `cpu`, `memory`, `graphics`, `sound`, `maxcontr'
    - name: v1-Platforms-Images
      path: /v1/Platforms/Images
      operations:
      - name: platformsimages
        method: GET
        description: Fetch platform(s) images by platform(s) id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: apikey
          in: query
          type: string
          description: (Required)
          required: true
        - name: platforms_id
          in: query
          type: string
          description: (Required) - platform(s) `id` can be obtain from the above platforms api, supports `,` delimited list
          required: true
        - name: filter[type]
          in: query
          type: string
          description: '(Optional) - valid `,` delimited options: `fanart`, `banner`, `boxart`'
        - name: page
          in: query
          type: integer
          description: (Optional) - results page offset to return
  exposes:
  - type: rest
    namespace: thegamesdb-platforms-rest
    port: 8080
    description: REST adapter for TheGamesDB API — Platforms. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/v1/platforms
      name: v1-platforms
      description: REST surface for v1-Platforms.
      operations:
      - method: GET
        name: platforms
        description: Fetch platforms list
        call: thegamesdb-platforms.platforms
        with:
          apikey: rest.apikey
          fields: rest.fields
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/platforms/byplatformid
      name: v1-platforms-byplatformid
      description: REST surface for v1-Platforms-ByPlatformID.
      operations:
      - method: GET
        name: platformsbyplatformid
        description: Fetch platforms list by id
        call: thegamesdb-platforms.platformsbyplatformid
        with:
          apikey: rest.apikey
          id: rest.id
          fields: rest.fields
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/platforms/byplatformname
      name: v1-platforms-byplatformname
      description: REST surface for v1-Platforms-ByPlatformName.
      operations:
      - method: GET
        name: platformsbyplatformname
        description: Fetch platforms by name
        call: thegamesdb-platforms.platformsbyplatformname
        with:
          apikey: rest.apikey
          name: rest.name
          fields: rest.fields
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/platforms/images
      name: v1-platforms-images
      description: REST surface for v1-Platforms-Images.
      operations:
      - method: GET
        name: platformsimages
        description: Fetch platform(s) images by platform(s) id
        call: thegamesdb-platforms.platformsimages
        with:
          apikey: rest.apikey
          platforms_id: rest.platforms_id
          filter[type]: rest.filter[type]
          page: rest.page
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: thegamesdb-platforms-mcp
    port: 9090
    transport: http
    description: MCP adapter for TheGamesDB API — Platforms. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: fetch-platforms-list
      description: Fetch platforms list
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: thegamesdb-platforms.platforms
      with:
        apikey: tools.apikey
        fields: tools.fields
      outputParameters:
      - type: object
        mapping: $.
    - name: fetch-platforms-list-id
      description: Fetch platforms list by id
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: thegamesdb-platforms.platformsbyplatformid
      with:
        apikey: tools.apikey
        id: tools.id
        fields: tools.fields
      outputParameters:
      - type: object
        mapping: $.
    - name: fetch-platforms-name
      description: Fetch platforms by name
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: thegamesdb-platforms.platformsbyplatformname
      with:
        apikey: tools.apikey
        name: tools.name
        fields: tools.fields
      outputParameters:
      - type: object
        mapping: $.
    - name: fetch-platform-s-images-platform-s-id
      description: Fetch platform(s) images by platform(s) id
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: thegamesdb-platforms.platformsimages
      with:
        apikey: tools.apikey
        platforms_id: tools.platforms_id
        filter[type]: tools.filter[type]
        page: tools.page
      outputParameters:
      - type: object
        mapping: $.