NESO Data Portal API — Search

naftiko: 1.0.0-alpha2
info:
  label: NESO Data Portal API — Search
  description: 'NESO Data Portal API — Search. 2 operations. Lead operation: Search datasets. Self-contained Naftiko capability
    covering one National Energy System Operator business surface.'
  tags:
  - National Energy System Operator
  - Search
  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-search
    baseUri: https://api.neso.energy/api/3/action
    description: NESO Data Portal API — Search business capability. Self-contained, no shared references.
    resources:
    - name: package_search
      path: /package_search
      operations:
      - name: packagesearch
        method: GET
        description: Search datasets
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: q
          in: query
          type: string
          description: Search query string.
          required: true
    - name: resource_search
      path: /resource_search
      operations:
      - name: resourcesearch
        method: GET
        description: Search resources
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: q
          in: query
          type: string
          description: Search query string.
          required: true
  exposes:
  - type: rest
    namespace: national-energy-system-operator-search-rest
    port: 8080
    description: REST adapter for NESO Data Portal API — Search. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/package-search
      name: package-search
      description: REST surface for package_search.
      operations:
      - method: GET
        name: packagesearch
        description: Search datasets
        call: national-energy-system-operator-search.packagesearch
        with:
          q: rest.q
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/resource-search
      name: resource-search
      description: REST surface for resource_search.
      operations:
      - method: GET
        name: resourcesearch
        description: Search resources
        call: national-energy-system-operator-search.resourcesearch
        with:
          q: rest.q
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: national-energy-system-operator-search-mcp
    port: 9090
    transport: http
    description: MCP adapter for NESO Data Portal API — Search. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: search-datasets
      description: Search datasets
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: national-energy-system-operator-search.packagesearch
      with:
        q: tools.q
      outputParameters:
      - type: object
        mapping: $.
    - name: search-resources
      description: Search resources
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: national-energy-system-operator-search.resourcesearch
      with:
        q: tools.q
      outputParameters:
      - type: object
        mapping: $.