raw_quick_help

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

With no annotations, the description carries the full burden and does well: it discloses that the action is static, takes no arguments, and may open a dialog or change project state. The caution to 'inspect the command name first' is a meaningful behavioral warning beyond what the schema reveals.

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 sentences with no filler, and the 'brief help message' purpose is front-loaded. Minor deduction: 'QuickHelp:' is a label rather than essential content, but overall the description is compact and readable.

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?

For a zero-argument tool with no output schema, the description covers the essential action and the important caveat about side effects. It could be slightly stronger by clarifying what happens after the help is displayed or by contrasting with longer help tools, but nothing critical is missing for 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?

There are zero parameters, and the baseline for 0-parameter tools is 4. The description explicitly reinforces that this is a 'no-argument' action, so there is no missing parameter information.

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 the specific verb 'Display' with the resource 'a brief help message', which is identifiable from the name. It does not explicitly differentiate itself from siblings like raw_help or raw_manual, though 'brief' gives some implicit contrast.

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 states this is a static no-argument action, which implies simple invocation, and warns about potential side effects. However, there is no explicit guidance about when to prefer this over nearby help-related siblings such as raw_help or raw_manual, nor any exclusions.

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