qgis_algorithm_help

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

No annotations present, but description details what is returned: display name, group, short help text, and per parameter/output details. Implies read-only behavior, but does not explicitly state no side effects.

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: first states purpose, second adds usage tip and output contents. No wasted words, well-structured.

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 simple input and existence of output schema, description fully equips agent to use tool correctly. Includes necessary prerequisite and return structure.

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?

Only one parameter (algorithm_id) with 0% schema description coverage. Description explains it's the identifier from qgis_list_algorithms and what the tool returns, adding meaning beyond the schema.

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 the tool describes a Processing algorithm's parameters and outputs, with specific verb 'describe' and resource. It distinguishes from siblings like qgis_list_algorithms and qgis_run_algorithm.

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?

Explicitly instructs to call qgis_list_algorithms first to get algorithm_id, providing a clear precondition. No exclusions mentioned, but context is sufficient.

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