Update a published page in place

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 operation is an in-place overwrite ("Replace the HTML"), that the URL is preserved, and that authorization is scoped to the calling API key's account. It stops short of saying what happens when the slug doesn't exist (error vs. create) or whether prior revisions are recoverable, which matters for an irreversible-looking overwrite.

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?

Three short sentences, front-loaded with the core action and the link-preservation guarantee, then the usage rule, then the ownership caveat. No restatement of the name or schema, and every clause carries decision-relevant information.

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 two-parameter update tool with no annotations and no output schema, the definition covers purpose, alternative, and access scope adequately. The remaining gap is the outcome on failure (nonexistent or unowned slug) and whether anything is returned, but these are minor for a tool this simple.

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 description coverage is 100%, so slug and html are already documented, including that slug may be a bare slug or a full URL and that html must be a complete self-contained document. The description adds only indirect meaning, tying the slug to the link the user already shared. Baseline 3 is appropriate since the schema does the heavy lifting.

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?

"Replace the HTML of a page you already published, keeping the SAME link" gives a specific verb (replace), resource (page HTML) and the distinguishing invariant (link stability). It explicitly contrasts with publishing a new page, which is the behavior of the sibling publish_html, so an agent can pick between them without opening either schema.

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?

States the condition for use ("every revision — a fix, a new draft, refreshed numbers") and names the alternative to avoid ("instead of publishing a new page"), including the reason: a shared link must keep working. It also states an eligibility constraint (only pages owned by the same API key's account), which is a when-you-cannot-use-this rule.

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