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

Annotations only declare readOnlyHint=false and destructiveHint=false, so the description must carry the rest — and it does add real value by stating that omitted fields are preserved and that content replaces all content blocks (a merge-vs-overwrite distinction an agent would otherwise guess wrong). However, the concurrency failure mode (what happens on a revision mismatch), the role of change_note, and the effect of idempotency_key are all undisclosed.

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 tight sentences, front-loaded with the operation and immediately followed by the required precondition. Every sentence carries information; no filler or restatement of the title.

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?

An output schema exists, so return values need not be described, and the optimistic-concurrency requirement plus the overwrite semantics for content are the two things an agent most needs. The remaining gap is error/conflict handling and the two undocumented auxiliary parameters, which keeps it below complete.

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 0% across 8 parameters, so the description has to compensate and only partly does: it explains expected_revision's provenance and the null-means-preserve behavior for the optional fields. Nothing is said about idempotency_key, change_note, or topic_id, leaving several parameters undocumented in both places.

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?

"Edit an existing published topic" gives a specific verb (edit) and resource (topic) with a scope qualifier (existing published), which separates it from get_topic (read) and create_topic_at_position (create). It stops short of naming those siblings explicitly, so it is clear but not fully differentiated.

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?

It prescribes a concrete workflow: read with get_topic first, then pass that version as expected_revision. That implicitly tells the agent not to call it without a prior read, which is strong context. It does not cover when to prefer other edit paths or what to do when the revision has moved on.

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