FMCSA QCMobile API — Carriers

naftiko: 1.0.0-alpha2
info:
  label: FMCSA QCMobile API — Carriers
  description: 'FMCSA QCMobile API — Carriers. 2 operations. Lead operation: Look up carriers by legal name. Self-contained
    Naftiko capability covering one Department Of Transportation business surface.'
  tags:
  - Department Of Transportation
  - Carriers
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    DEPARTMENT_OF_TRANSPORTATION_API_KEY: DEPARTMENT_OF_TRANSPORTATION_API_KEY
capability:
  consumes:
  - type: http
    namespace: fmcsa-qcmobile-carriers
    baseUri: https://mobile.fmcsa.dot.gov/qc/services
    description: FMCSA QCMobile API — Carriers business capability. Self-contained, no shared references.
    resources:
    - name: carriers-name-name
      path: /carriers/name/{name}
      operations:
      - name: getcarriersbyname
        method: GET
        description: Look up carriers by legal name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
    - name: carriers-dotNumber
      path: /carriers/{dotNumber}
      operations:
      - name: getcarrierbydotnumber
        method: GET
        description: Look up a carrier by USDOT number
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dotNumber
          in: path
          type: integer
          required: true
    authentication:
      type: apikey
      key: webKey
      value: '{{env.DEPARTMENT_OF_TRANSPORTATION_API_KEY}}'
      placement: query
  exposes:
  - type: rest
    namespace: fmcsa-qcmobile-carriers-rest
    port: 8080
    description: REST adapter for FMCSA QCMobile API — Carriers. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/carriers/name/{name}
      name: carriers-name-name
      description: REST surface for carriers-name-name.
      operations:
      - method: GET
        name: getcarriersbyname
        description: Look up carriers by legal name
        call: fmcsa-qcmobile-carriers.getcarriersbyname
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/carriers/{dotnumber}
      name: carriers-dotnumber
      description: REST surface for carriers-dotNumber.
      operations:
      - method: GET
        name: getcarrierbydotnumber
        description: Look up a carrier by USDOT number
        call: fmcsa-qcmobile-carriers.getcarrierbydotnumber
        with:
          dotNumber: rest.dotNumber
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: fmcsa-qcmobile-carriers-mcp
    port: 9090
    transport: http
    description: MCP adapter for FMCSA QCMobile API — Carriers. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: look-up-carriers-legal-name
      description: Look up carriers by legal name
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: fmcsa-qcmobile-carriers.getcarriersbyname
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: look-up-carrier-usdot-number
      description: Look up a carrier by USDOT number
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: fmcsa-qcmobile-carriers.getcarrierbydotnumber
      with:
        dotNumber: tools.dotNumber
      outputParameters:
      - type: object
        mapping: $.