Nitromule

Nitromule MCP server

Updated 2026-09-07

On this page

MCP is an access channel on top of the Integrations API — not a separate shipping product. Agents use the same orders, rates, labels, and ownership rules as REST.

Availability

Hosted MCP may be staging-only or flag-gated in production. If /mcp/v1 is not enabled on your stack, use the REST API. Servers can force off with NM_MCP_ENABLED=0 or enable with NM_MCP_ENABLED=1.

Remote URL:

https://<your-nitromule-host>/mcp/v1

Connect (OAuth)

  1. Point your MCP client at /mcp/v1.
  2. Client receives 401 and discovers OAuth via protected-resource metadata.
  3. Browser opens Nitromule login (if needed) and Allow on the consent screen.
  4. Choose Test (default) or Live — same split as nm_test_ / nm_live_ keys.
  5. Client stores an opaque nm_mcp_… access token (no API key in client config).

Optional: Authorization: Bearer nm_test_… or nm_live_… directly on /mcp/v1.

Tools

Tool Purpose
nm_me Identity / smoke; includes key_environment
nm_list_orders / nm_get_order Read orders
nm_create_order / nm_update_order Write orders (confirm)
nm_get_rates Rate shop
nm_buy_label Place Order (may charge Billing; confirm; may 402)
nm_get_shipment / nm_void_label Shipment get / void (confirm)
nm_track Tracking
nm_validate_address Address validate
nm_list_carriers Carriers

Batches, manifests, pickups, and catalog tools are deferred.

Agent safety

  • Call nm_me and confirm key_environment is test before buying
  • Prefer confirm-gated tools for create/buy/void
  • Same ownership boundary as REST — no cross-user admin via MCP

Non-goals (current phase)

  • Separate mcp. subdomain service
  • 1:1 mirror of every REST route as a tool
  • Admin / cross-merchant MCP

Authentication · Quickstart · OpenAPI · Test mode

Related articles