Skip to content

docs: align MCP tool reference with live schemas #361

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dodeja merged 2 commits into from
Sep 10, 2026
+12 −8
Merged

docs: align MCP tool reference with live schemas #361

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2ccefaa
docs: align MCP tool parameters with live schemas
cursoragent Sep 10, 2026
df7963d
docs: clarify get container event summary
cursoragent Sep 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 12 additions & 8 deletions docs/mcp/home.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,9 @@ Get detailed container information with flexible data loading. Choose what to in
- `include` *(string[], optional)* – what to load:
- `shipment` – routing, BOL, line, ref numbers (lightweight)
- `pod_terminal` – terminal name, location (lightweight)
- `transport_events` – full event history (heavy, 50-100 events)
- `transport_events` – adds `events.count`, `events.rail_events_count`, and `events.latest_event`; use `get_container_transport_events` for the full timeline

The response may also include `_metadata` with factual details such as `includes_loaded`.

<Accordion title="Example MCP request">
```json
Expand Down Expand Up @@ -394,13 +396,14 @@ See [Entitlements and Paid Features](/api-docs/useful-info/entitlements) for the
List shipments with optional filters and pagination.

**Parameters**
- `status`, `port`, `carrier`, `updated_after` *(string, optional)*
- `number` *(string, optional)* – shipment, booking, or Bill of Lading identifier
- `tracking_stopped` *(boolean, optional)* – filter by whether shipping-line tracking has stopped
- `include_containers` *(boolean, optional)*
- `page`, `page_size` *(number, optional)*

**Good for**
- "List recent shipments"
- "Show in-transit shipments for MAEU"
- "Find a shipment by booking or Bill of Lading number"

**REST equivalent**: [GET /shipments](/api-docs/api-reference/shipments/list-shipments)

Expand All @@ -411,13 +414,12 @@ List shipments with optional filters and pagination.
List containers with optional filters and pagination.

**Parameters**
- `status`, `port`, `carrier`, `updated_after` *(string, optional)*
- `include` *(string, optional)* – comma-separated include list
- `include` *(string[], optional)* – include `shipment`, `pod_terminal`, or both
- `page`, `page_size` *(number, optional)*

**Good for**
- "List containers updated in the last 24h"
- "Show containers at a specific POD port"
- "List containers in my account"
- "List containers with their shipment and POD terminal details"

**REST equivalent**: [GET /containers](/api-docs/api-reference/containers/list-containers)

Expand All @@ -428,7 +430,9 @@ List containers with optional filters and pagination.
List tracking requests with optional filters and pagination.

**Parameters**
- `filters` *(object, optional)* – raw query filters
- `request_number` *(string, optional)* – tracking request identifier
- `status` *(string, optional)* – `created`, `pending`, `succeeded`, or `failed`

@chatgpt-codex-connector chatgpt-codex-connector Bot Sep 10, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Remove the unsupported succeeded status

When a caller follows this reference and passes status: "succeeded", list_tracking_requests forwards it unchanged as filter[status], but the OpenAPI filter permits only created, pending, and failed, and the tracking-request model has no succeeded state. tracking_request.succeeded is a webhook event; successful requests use created, so this value cannot retrieve the promised records and may be rejected by the API. Remove it from the documented statuses, or update the underlying API/tool contract before advertising it.

AGENTS.md reference: AGENTS.md:L23-L27

Useful? React with 👍 / 👎.

- `scac` *(string, optional)* – four-letter shipping line SCAC
- `page`, `page_size` *(number, optional)*

**Good for**
Expand Down
Loading