jactus_get_doc_structure

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

With no annotations, the description bears full burden. It discloses that the tool returns file names with headers and requires a specific environment setup. However, it does not mention potential errors, rate limits, or side effects, though as a read-only operation with output schema, this is acceptable.

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?

Description is three sentences, front-loaded with verb and resource, then purpose and prerequisite. No unnecessary words; every sentence provides value.

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?

Given zero parameters, existence of output schema, and sibling tools that cover other functions, the description is complete. It defines what it does, its role in the workflow, and a setup requirement.

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?

Tool has zero parameters. Per guidelines, 0 params yields baseline 4. Description does not add parameter semantics, but none are needed.

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?

Description clearly states verb 'Get' and resource 'structure of JACTUS documentation', listing files with section headers. It hints at usefulness before searching but does not explicitly distinguish from all sibling tools like jactus_get_topic_guide.

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?

Description advises using this tool to understand available documentation before searching, implying a pre-search use case. It also notes the requirement of JACTUS source tree access and setting the JACTUS_ROOT env var, providing clear context.

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