Get docs navigation
get_navigationReturn the documentation navigation tree for the current docs site.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| locale | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| markdown | Yes | ||
| navigation | Yes |
get_navigationReturn the documentation navigation tree for the current docs site.
| Name | Required | Description | Default |
|---|---|---|---|
| locale | No |
| Name | Required | Description | Default |
|---|---|---|---|
| markdown | Yes | ||
| navigation | Yes |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The readOnlyHint annotation already declares this as a safe read, lowering the disclosure burden. The description adds the useful scoping detail that the tree is for the 'current docs site', but says nothing about whether the tree reflects the published or draft state, or how locale affects the result.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single front-loaded sentence with no filler or repetition. Every clause carries meaning and nothing needs trimming.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values need not be described. However, the undocumented locale parameter and the absence of any usage routing leave the definition only minimally complete for an agent trying to invoke it with a non-default locale.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
With 0% schema description coverage, the single 'locale' parameter is entirely undocumented in both schema and description. The phrase 'current docs site' hints at site scoping but gives no meaning to locale, so the description does not compensate for the coverage gap.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb (return) and resource (documentation navigation tree) scoped to the current docs site. It is clearly distinguishable from list_pages and list_docs in concept, but does not explicitly name or contrast with any sibling tool.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use guidance, no prerequisites, and no mention of alternatives such as list_pages or list_page_sections. The agent must infer when a navigation tree is preferable to a flat page listing.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.