publish_html

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

No annotations are provided, so the description must disclose behavioral traits. It mentions that Markdown is 'rendered into a clean reader page' and that publishing yields a 'shareable URL,' but it omits important behaviors such as the default TTL of 7 days for anonymous tier, password protection options, and ownership semantics. The description also does not mention potential side effects or limitations, leaving the agent unaware of constraints like expiration or access control.

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, with the first stating the core function and the second listing use cases. It is front-loaded, using specific terms like 'publish' and 'shareable URL' immediately. There is no fluff or redundant information, making it concise and 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?

The description covers the primary purpose and output ('get a shareable URL'), and the schema handles parameter details. It does not explain the return structure or the effects of optional fields like ttl_days and password, but given the moderate complexity and absence of an output schema, the description is largely sufficient. However, it could be more complete by mentioning that published artifacts have a default TTL and can be password-protected, which are important operational details.

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 input schema has 100% parameter description coverage, so the baseline is 3. The description adds minimal parameter-related context beyond the schema, such as clarifying that 'Markdown is rendered into a clean reader page.' However, it does not elaborate on the relationships between parameters (e.g., that html, markdown, and url are mutually exclusive alternatives), which the schema already conveys via the anyOf constraint. The description does not significantly enrich the schema's parameter meanings.

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 function: 'Publish an HTML or markdown artifact (or fetch a remote HTML page) and get a shareable URL.' This is a specific verb+resource combination that unambiguously describes the action and output. Although no siblings are listed, the description is self-sufficient and leaves no doubt about the tool's purpose.

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 provides clear context for when to use the tool: 'Useful for sharing reports, dashboards, visualizations, or any document produced by an agent.' This indicates appropriate scenarios but does not explicitly mention alternatives or exclusions. Since there are no sibling tools, the absence of explicit alternatives is acceptable, but the description could benefit from stating when not to use it (e.g., for non-publishable content).

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