apex_generate_docs

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is clear. The description adds the scope of documentation (pages, regions, items) but does not disclose additional behavioral traits such as return format, side effects, or any requirements. This is consistent with annotations and adds moderate context beyond them.

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?

The description is a single concise sentence that front-loads the main purpose and scope ('Auto-generate Markdown documentation for an app (pages, regions, items)'). Every word contributes useful information with no redundancy or filler.

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 the tool's simplicity (one optional parameter, output schema present, strong annotations), the description covers the core purpose and scope adequately. It does not mention when to use it or what happens with the generated docs, but the existing structured data mitigates the need for further detail. The description is slightly thin on usage context but remains sufficient for this low-complexity tool.

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 100% and the parameter description already explains that app_id defaults to session.app_id. The tool description adds no further parameter-specific semantics, so the baseline of 3 is appropriate given the high schema coverage.

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 clearly states the tool's function: 'Auto-generate Markdown documentation for an app (pages, regions, items).' It uses a specific verb ('auto-generate'), identifies the resource ('Markdown documentation for an app'), and scopes the content to pages, regions, and items. This distinguishes it from all sibling tools, including apex_describe_page, which focuses on a single page.

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?

The description implies usage for generating app documentation but provides no explicit guidance on when to use this tool versus alternatives, nor any exclusions or prerequisites. Sibling tools like apex_describe_page or apex_get_app_details might serve similar contexts, but the description does not mention them, so usage context is only implied.

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