UpKeep API — Meters

naftiko: 1.0.0-alpha2
info:
  label: UpKeep API — Meters
  description: 'UpKeep API — Meters. 3 operations. Lead operation: List Meters. Self-contained Naftiko capability covering
    one Upkeep business surface.'
  tags:
  - Upkeep
  - Meters
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    UPKEEP_API_KEY: UPKEEP_API_KEY
capability:
  consumes:
  - type: http
    namespace: upkeep-meters
    baseUri: https://api.onupkeep.com/api/v2
    description: UpKeep API — Meters business capability. Self-contained, no shared references.
    resources:
    - name: meters
      path: /meters
      operations:
      - name: listmeters
        method: GET
        description: List Meters
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: page
          in: query
          type: integer
        - name: limit
          in: query
          type: integer
      - name: createmeter
        method: POST
        description: Create Meter
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: meters-id-readings
      path: /meters/{id}/readings
      operations:
      - name: submitmeterreading
        method: POST
        description: Submit Meter Reading
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Meter identifier
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: session-token
      value: '{{env.UPKEEP_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: upkeep-meters-rest
    port: 8080
    description: REST adapter for UpKeep API — Meters. One Spectral-compliant resource per consumed operation, prefixed with
      /v1.
    resources:
    - path: /v1/meters
      name: meters
      description: REST surface for meters.
      operations:
      - method: GET
        name: listmeters
        description: List Meters
        call: upkeep-meters.listmeters
        with:
          page: rest.page
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createmeter
        description: Create Meter
        call: upkeep-meters.createmeter
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/meters/{id}/readings
      name: meters-id-readings
      description: REST surface for meters-id-readings.
      operations:
      - method: POST
        name: submitmeterreading
        description: Submit Meter Reading
        call: upkeep-meters.submitmeterreading
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: upkeep-meters-mcp
    port: 9090
    transport: http
    description: MCP adapter for UpKeep API — Meters. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-meters
      description: List Meters
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: upkeep-meters.listmeters
      with:
        page: tools.page
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.
    - name: create-meter
      description: Create Meter
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: upkeep-meters.createmeter
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: submit-meter-reading
      description: Submit Meter Reading
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: upkeep-meters.submitmeterreading
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.