gramax_get_navigation

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries the burden and it discloses the main behavioral outcome: the operation is a read ('get') that returns a navigation tree composed of sections, articles, and links. It does not mention auth or error behavior, but for a simple one-parameter read tool with an output schema, this is reasonably transparent.

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?

Two short sentences with no filler. The main purpose is front-loaded, and the parameter guidance is separated cleanly. Every word earns its place.

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?

The tool is simple: one required parameter, an output schema, and clear sibling context. The description provides the purpose, the parameter source, and the return shape. Nothing essential is missing for correct invocation.

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?

Schema coverage is 0%, but the description fully compensates for the single parameter: it identifies catalog_id as the catalog identifier and, crucially, tells the agent how to obtain it via gramax_list_catalogs. This is exactly the semantic information the schema lacks.

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?

The description uses a specific verb-resource pair: 'get the catalog navigation tree' and enumerates what that tree contains (sections, articles, links). This clearly differentiates it from siblings like gramax_get_article and gramax_list_catalogs.

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?

It gives explicit practical guidance: the catalog_id should be obtained via gramax_list_catalogs, which tells the agent how to populate the required parameter. It does not explicitly discuss when to prefer this over the search siblings, but the primary usage context is clear enough.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.