NESO Data Portal API — Discovery

naftiko: 1.0.0-alpha2
info:
  label: NESO Data Portal API — Discovery
  description: 'NESO Data Portal API — Discovery. 3 operations. Lead operation: List data groups. Self-contained Naftiko capability
    covering one National Energy System Operator business surface.'
  tags:
  - National Energy System Operator
  - Discovery
  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-discovery
    baseUri: https://api.neso.energy/api/3/action
    description: NESO Data Portal API — Discovery business capability. Self-contained, no shared references.
    resources:
    - name: organization_list
      path: /organization_list
      operations:
      - name: organizationlist
        method: GET
        description: List data groups
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: package_list
      path: /package_list
      operations:
      - name: packagelist
        method: GET
        description: List datasets
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: tag_list
      path: /tag_list
      operations:
      - name: taglist
        method: GET
        description: List tags
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    namespace: national-energy-system-operator-discovery-rest
    port: 8080
    description: REST adapter for NESO Data Portal API — Discovery. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/organization-list
      name: organization-list
      description: REST surface for organization_list.
      operations:
      - method: GET
        name: organizationlist
        description: List data groups
        call: national-energy-system-operator-discovery.organizationlist
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/package-list
      name: package-list
      description: REST surface for package_list.
      operations:
      - method: GET
        name: packagelist
        description: List datasets
        call: national-energy-system-operator-discovery.packagelist
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/tag-list
      name: tag-list
      description: REST surface for tag_list.
      operations:
      - method: GET
        name: taglist
        description: List tags
        call: national-energy-system-operator-discovery.taglist
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: national-energy-system-operator-discovery-mcp
    port: 9090
    transport: http
    description: MCP adapter for NESO Data Portal API — Discovery. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-data-groups
      description: List data groups
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: national-energy-system-operator-discovery.organizationlist
      outputParameters:
      - type: object
        mapping: $.
    - name: list-datasets
      description: List datasets
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: national-energy-system-operator-discovery.packagelist
      outputParameters:
      - type: object
        mapping: $.
    - name: list-tags
      description: List tags
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: national-energy-system-operator-discovery.taglist
      outputParameters:
      - type: object
        mapping: $.