MCP tool reference template
MCP tool pages are generated byscripts/build-mcp-tools-from-export.py. Do not create or edit an individual generated page by hand. Update the registered tool description or Zod schema in dashboard-be, export the catalog, and run the builder.
Each generated tool page must provide the following information:
- A specific title and description that include the MCP tool name.
- A safety label: read only, changes state, destructive, or billable.
- The exact server description inside the matching
mcp-syncblock. - A source-backed parameter table with required fields, enums, defaults, and descriptions.
- A
tools/callJSON-RPC request shape containing required parameters. - Retry guidance appropriate to the tool’s side effects.
- Links to tools named by the server description, the resource overview, connection setup, and error handling.
Review gates
- One page exists for every exported tool, and no stale generated tool page remains.
- The tool name appears once in
docs.jsonnavigation. - Source descriptions and parameter descriptions are unchanged inside
mcp-syncblocks except for required MDX escaping. - The tracked manifest hash matches every generated
mcp-syncblock. - Billable and destructive operations are classified explicitly in the builder.
- Required object and array examples do not claim that empty placeholder values are complete requests.
- Every superseded collection URL redirects to its resource overview.
python3 scripts/validate_mcp_tool_docs.pypasses.- Mintlify validation passes.