ARK TMS

MCP documentation | MCP docs for agents

ark_preview_carrier_provider_onboarding

ark.preview_carrier_provider_onboarding

Preview a carrier in Highway, RMIS, or MyCarrierPortal before sending an external onboarding invitation, including provider risk and contact context.

Availability
Expanded preview
Scopes
carriers:read
ARK permissions
canInviteCarrierExternal
Team visibility
Not entity-scoped
Approval policy
none
ARK approval request
Not required
Idempotency
Not required
Read-only
Yes
Destructive
No
External side effect
Yes
Rate limit
OAuth MCP credential and organization budgets

Input

providerstringrequired

External carrier onboarding provider to preview.

one of: highway, rmis, mycarrierportal

dotNumberstring

Optional DOT number lookup.

min length: 1; max length: 32

mcNumberstring

Optional MC/MX docket number lookup.

min length: 1; max length: 32

highwayCarrierIdstring

Highway carrier ID when using the Highway provider.

min length: 1; max length: 64

highwayExternalIdstring

Highway external ID when using the Highway provider.

min length: 1; max length: 100

emailstring

Optional contact email to include in provider advisory checks.

format: email; max length: 254

includeCarrierDataboolean

For MyCarrierPortal, include detailed carrier enrichment data.

default: false

Result

The tool returns the canonical ark.preview_carrier_provider_onboarding operation result in structuredContent and mirrors the same JSON as text. Errors set isError: true and return a stable error code, message, and optional details.