invokeai_help

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

No annotations are provided, so the description carries the burden. It discloses the return format as a JSON object with 'success' and 'help' fields, and provides examples of usage. While it doesn't explicitly state read-only behavior or side effects, the nature of 'getting documentation' implies a safe, non-mutating operation, and the return format adds useful transparency.

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 extremely concise: a one-line purpose, a structured return format, and two examples. No wasted words, and the use of headers improves scannability. Every sentence contributes to understanding the tool's behavior.

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 simple tool with one optional parameter, the description is complete: it states the purpose, return format, and provides examples. It also mentions that omitting 'topic' returns the index, covering the default behavior. The presence of the return format in the description means no need for a separate output schema explanation.

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?

The schema already describes the 'topic' parameter as 'Help topic, or omit for the index' with 100% coverage. The description adds value by showing concrete examples (invokeai_help() and invokeai_help(topic='tools')), clarifying how the parameter is used and what 'index' means in practice.

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 purpose: 'Get documentation for this server's tools and workflows.' This is a specific verb-resource pair that distinguishes it from sibling tools like invokeai_generate or invokeai_queue, which perform operations rather than provide help.

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 when to use the tool: whenever you need documentation for tools or workflows. It doesn't explicitly compare with alternatives, but as a help tool, its role is self-evident. The context is clear, though no formal when-not-to-use guidance is given.

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