apex_generate_report_page

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

Annotations are all false, providing no safety or side-effect hints. The description 'Generate' implies a creation operation but does not disclose what happens if the page ID already exists, whether authorization is required, or any other side effects. For a mutation tool, this lacks important behavioral context.

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 is front-loaded with the primary action ('Generate an IR report page') and a secondary qualifier (optional filter items). No unnecessary words or repetition.

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 has 8 parameters and an output schema, but the description is very brief. It does not explain what 'IR' stands for or mention typical prerequisites (e.g., existing app connection) or behavior on existing pages. However, the rich schema descriptions partially compensate, so it is minimally complete but not thorough.

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%, so the baseline is 3. The description mentions 'optional filter items' but the schema already explains filter_items in detail with examples. The description adds no new parameter meaning beyond what the schema provides, so it does not go above the baseline.

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 states a specific action: 'Generate an IR report page' with optional filter items (text/select/date). It clearly identifies the resource (Interactive Report page) and distinguishes from sibling generators like dashboard or analytics page. The mention of filter item types adds useful specificity.

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: if you need an IR report page with optional filters, use this tool. However, it does not explicitly contrast with alternatives (e.g., apex_add_interactive_grid, apex_generate_analytics_page) or state when not to use it. There is no exclusion or alternative naming, so the guidance is only implicit.

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