NESO Data Portal API — Metadata

naftiko: 1.0.0-alpha2
info:
  label: NESO Data Portal API — Metadata
  description: 'NESO Data Portal API — Metadata. 2 operations. Lead operation: Show dataset. Self-contained Naftiko capability
    covering one National Energy System Operator business surface.'
  tags:
  - National Energy System Operator
  - Metadata
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    NATIONAL_ENERGY_SYSTEM_OPERATOR_API_KEY: NATIONAL_ENERGY_SYSTEM_OPERATOR_API_KEY
capability:
  consumes:
  - type: http
    namespace: national-energy-system-operator-metadata
    baseUri: https://api.neso.energy/api/3/action
    description: NESO Data Portal API — Metadata business capability. Self-contained, no shared references.
    resources:
    - name: package_show
      path: /package_show
      operations:
      - name: packageshow
        method: GET
        description: Show dataset
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: query
          type: string
          description: Dataset identifier or slug.
          required: true
    - name: resource_show
      path: /resource_show
      operations:
      - name: resourceshow
        method: GET
        description: Show resource
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: query
          type: string
          description: Resource identifier (UUID).
          required: true
  exposes:
  - type: rest
    namespace: national-energy-system-operator-metadata-rest
    port: 8080
    description: REST adapter for NESO Data Portal API — Metadata. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/package-show
      name: package-show
      description: REST surface for package_show.
      operations:
      - method: GET
        name: packageshow
        description: Show dataset
        call: national-energy-system-operator-metadata.packageshow
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/resource-show
      name: resource-show
      description: REST surface for resource_show.
      operations:
      - method: GET
        name: resourceshow
        description: Show resource
        call: national-energy-system-operator-metadata.resourceshow
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: national-energy-system-operator-metadata-mcp
    port: 9090
    transport: http
    description: MCP adapter for NESO Data Portal API — Metadata. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: show-dataset
      description: Show dataset
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: national-energy-system-operator-metadata.packageshow
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: show-resource
      description: Show resource
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: national-energy-system-operator-metadata.resourceshow
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.