Skip to content

docs: align MCP tool reference with live schemas - #361

Merged
dodeja merged 2 commits into
mainfrom
cursor/fix-mcp-docs-schema-6371
Sep 10, 2026
Merged

docs: align MCP tool reference with live schemas#361
dodeja merged 2 commits into
mainfrom
cursor/fix-mcp-docs-schema-6371

Conversation

@dodeja

@dodeja dodeja commented Sep 10, 2026

Copy link
Copy Markdown
Member

Summary

  • align list_shipments, list_containers, and list_tracking_requests parameters with the live MCP schemas
  • document the exact get_container transport-event summary fields and point to get_container_transport_events for the full timeline
  • note that factual _metadata, such as includes_loaded, may remain in responses
  • retain track_container.number as required

Verification

  • compared the documentation against MCP schemas on main after API#360 and the live mcpdemo response
  • targeted stale-parameter and stripped-steering-field searches
  • git diff --check

Linear: DEV-12451

Open in Web Open in Cursor 

View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need. Autofix is disabled.

Co-authored-by: Akshay Dodeja <dodeja@gmail.com>
@mintlify

mintlify Bot commented Sep 10, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
terminal49 🟢 Ready View Preview Sep 10, 2026, 6:55 PM

@vercel

vercel Bot commented Sep 10, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
api Ready Ready Preview Sep 10, 2026 6:56pm UTC

Request Review

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 10, 2026

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review Completed 2026-09-10T18:56:31.888693Z 2ccefaa PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

Co-authored-by: Akshay Dodeja <dodeja@gmail.com>

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 2ccefaabd6

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/mcp/home.mdx
**Parameters**
- `filters` *(object, optional)* – raw query filters
- `request_number` *(string, optional)* – tracking request identifier
- `status` *(string, optional)* – `created`, `pending`, `succeeded`, or `failed`

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 👍 / 👎.

@dodeja
dodeja merged commit 83f0db3 into main Sep 10, 2026
23 of 24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants