CGMIX Maritime Information Exchange API — Vessel Documentation

naftiko: 1.0.0-alpha2
info:
  label: CGMIX Maritime Information Exchange API — Vessel Documentation
  description: 'CGMIX Maritime Information Exchange API — Vessel Documentation. 1 operations. Lead operation: Search Vessel
    Documentation Status. Self-contained Naftiko capability covering one United States Coast Guard business surface.'
  tags:
  - United States Coast Guard
  - Vessel Documentation
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    UNITED_STATES_COAST_GUARD_API_KEY: UNITED_STATES_COAST_GUARD_API_KEY
capability:
  consumes:
  - type: http
    namespace: cgmix-maritime-information-exchange-vessel-documentation
    baseUri: https://cgmix.uscg.mil
    description: CGMIX Maritime Information Exchange API — Vessel Documentation business capability. Self-contained, no shared
      references.
    resources:
    - name: VDS-SearchAndReturn-Search.aspx
      path: /VDS/SearchAndReturn/Search.aspx
      operations:
      - name: searchvesseldocumentation
        method: GET
        description: Search Vessel Documentation Status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: vsnm
          in: query
          type: string
          description: Vessel name (partial match supported)
        - name: offn
          in: query
          type: string
          description: Official number assigned by USCG
        - name: hin
          in: query
          type: string
          description: Hull Identification Number
  exposes:
  - type: rest
    namespace: cgmix-maritime-information-exchange-vessel-documentation-rest
    port: 8080
    description: REST adapter for CGMIX Maritime Information Exchange API — Vessel Documentation. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/vds/searchandreturn/search-aspx
      name: vds-searchandreturn-search-aspx
      description: REST surface for VDS-SearchAndReturn-Search.aspx.
      operations:
      - method: GET
        name: searchvesseldocumentation
        description: Search Vessel Documentation Status
        call: cgmix-maritime-information-exchange-vessel-documentation.searchvesseldocumentation
        with:
          vsnm: rest.vsnm
          offn: rest.offn
          hin: rest.hin
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: cgmix-maritime-information-exchange-vessel-documentation-mcp
    port: 9090
    transport: http
    description: MCP adapter for CGMIX Maritime Information Exchange API — Vessel Documentation. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: search-vessel-documentation-status
      description: Search Vessel Documentation Status
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cgmix-maritime-information-exchange-vessel-documentation.searchvesseldocumentation
      with:
        vsnm: tools.vsnm
        offn: tools.offn
        hin: tools.hin
      outputParameters:
      - type: object
        mapping: $.