roiq_publish_html

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

The description discloses that the returned link is read-only and non-indexed, adding behavioral context. Without annotations, it lacks details on authorization, mutability, or whether the action is destructive.

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 two sentences long, direct, and front-loaded with the primary action and result. No wasted words.

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 description covers the core function and returns a link, but lacks details on return value structure, parameter constraints, and prerequisites. Given no output schema or annotations, the description is marginally adequate.

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 0%, and the description does not explain the purpose or expected format of the 'title' and 'html' parameters. No additional meaning is provided beyond the schema field names.

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 publishes self-contained HTML and returns a read-only non-indexed link. It distinguishes from siblings by specifying a unique action, but does not explicitly contrast with similar tools like roiq_create_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 advises confirming with the user before publishing externally, providing implicit usage context. However, it does not specify when to use this tool versus alternatives or define exclusions.

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