naftiko: 1.0.0-alpha2
info:
  label: VesselFinder AIS API — Status
  description: VesselFinder AIS API — Status. Account status (remaining credits, expiration date).
  tags:
    - VesselFinder
    - AIS
    - Account
  created: '2026-05-25'
  modified: '2026-05-25'
binds:
  - namespace: env
    keys:
      VESSELFINDER_USER_KEY: VESSELFINDER_USER_KEY
capability:
  consumes:
    - type: http
      namespace: ais-status
      baseUri: https://api.vesselfinder.com
      description: VesselFinder Status capability.
      resources:
        - name: status
          path: /status
          operations:
            - name: getstatus
              method: GET
              description: Get remaining credits and expiration date for the account.
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
              inputParameters:
                - name: userkey
                  in: query
                  type: string
                  required: true
                - name: format
                  in: query
                  type: string
      authentication:
        type: apikey
        key: userkey
        value: '{{env.VESSELFINDER_USER_KEY}}'
        placement: query
  exposes:
    - type: rest
      namespace: ais-status-rest
      port: 8080
      description: REST adapter for VesselFinder Status.
      resources:
        - path: /v1/status
          name: status
          description: REST surface for status.
          operations:
            - method: GET
              name: getstatus
              description: Get the account status.
              call: ais-status.getstatus
              outputParameters:
                - type: object
                  mapping: $.
    - type: mcp
      namespace: ais-status-mcp
      port: 9090
      transport: http
      description: MCP adapter for VesselFinder Status.
      tools:
        - name: vesselfinder-get-status
          description: Get remaining API credits and expiration date for the account.
          hints:
            readOnly: true
            destructive: false
            idempotent: true
          call: ais-status.getstatus
          outputParameters:
            - type: object
              mapping: $.