Skip to main content

MCP tool reference template

MCP tool pages are generated by scripts/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:
  1. A specific title and description that include the MCP tool name.
  2. A safety label: read only, changes state, destructive, or billable.
  3. The exact server description inside the matching mcp-sync block.
  4. A source-backed parameter table with required fields, enums, defaults, and descriptions.
  5. A tools/call JSON-RPC request shape containing required parameters.
  6. Retry guidance appropriate to the tool’s side effects.
  7. 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.json navigation.
  • Source descriptions and parameter descriptions are unchanged inside mcp-sync blocks except for required MDX escaping.
  • The tracked manifest hash matches every generated mcp-sync block.
  • 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.py passes.
  • Mintlify validation passes.