ARK TMS

MCP documentation | MCP docs for agents

ark_invite_carrier_provider_onboarding

ark.invite_carrier_provider_onboarding

Send a carrier onboarding invitation through Highway, RMIS, or MyCarrierPortal with the provider-specific fields required by ARK.

Availability
Expanded preview
Scopes
carriers:write
ARK permissions
canInviteCarrierExternal
Team visibility
Not entity-scoped
Approval policy
ask_before_send
ARK approval request
Required before execution
Idempotency
Required for external execution
Read-only
No
Destructive
No
External side effect
Yes
Rate limit
OAuth MCP credential and organization budgets

Input

providerstringrequired

External carrier onboarding provider that should send the invitation.

one of: highway, rmis, mycarrierportal

emailstringrequired

Carrier contact email that receives the provider invitation.

format: email; max length: 254

carrierIdstring

Optional ARK carrier ID to link provider invitation state.

format: uuid

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

companyNamestring

RMIS company name.

min length: 1; max length: 200

contactNamestring

RMIS carrier contact name.

min length: 1; max length: 200

createUserNamestring

RMIS sender name.

min length: 1; max length: 200

createUserEmailstring

RMIS sender email.

format: email; max length: 254

clientMemberIdstring

Optional RMIS ClientMemberID.

min length: 1; max length: 100

Result

The tool returns the canonical ark.invite_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.