OSIsoft PI Web API — DataServers

naftiko: 1.0.0-alpha2
info:
  label: OSIsoft PI Web API — DataServers
  description: 'OSIsoft PI Web API — DataServers. 1 operations. Lead operation: List PI Data Archive servers. Self-contained
    Naftiko capability covering one Osisoft Pi business surface.'
  tags:
  - Osisoft Pi
  - DataServers
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    OSISOFT_PI_API_KEY: OSISOFT_PI_API_KEY
capability:
  consumes:
  - type: http
    namespace: web-dataservers
    baseUri: https://{piwebapi_host}/piwebapi
    description: OSIsoft PI Web API — DataServers business capability. Self-contained, no shared references.
    resources:
    - name: dataservers
      path: /dataservers
      operations:
      - name: listdataservers
        method: GET
        description: List PI Data Archive servers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: selectedFields
          in: query
          type: string
          description: Comma-separated list of fields to return
    authentication:
      type: basic
      username: '{{env.OSISOFT_PI_USER}}'
      password: '{{env.OSISOFT_PI_PASS}}'
  exposes:
  - type: rest
    namespace: web-dataservers-rest
    port: 8080
    description: REST adapter for OSIsoft PI Web API — DataServers. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/dataservers
      name: dataservers
      description: REST surface for dataservers.
      operations:
      - method: GET
        name: listdataservers
        description: List PI Data Archive servers
        call: web-dataservers.listdataservers
        with:
          selectedFields: rest.selectedFields
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: web-dataservers-mcp
    port: 9090
    transport: http
    description: MCP adapter for OSIsoft PI Web API — DataServers. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-pi-data-archive-servers
      description: List PI Data Archive servers
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: web-dataservers.listdataservers
      with:
        selectedFields: tools.selectedFields
      outputParameters:
      - type: object
        mapping: $.