EasyTopic: write Documentation page

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

Discloses partial update behavior ('Only fields you pass'), versioning for title/descriptionHtml, and that metaDescription is not versioned. Mentions auth requirement but no rate limits or idempotency. With no annotations, this is solid.

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?

Two sentences, front-loaded with action and scope. No redundant phrases. Every sentence adds value.

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?

Covers main behavior, versioning, and precondition. Missing return value information (no output schema, and description does not mention what is returned). Otherwise complete given complexity.

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?

Despite 0% schema description coverage, the description explains the three optional params (title, descriptionHtml, metaDescription) with versioning context. Required params (projectId, topicId) are not detailed but are self-explanatory.

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?

Clearly states verb 'Updates' and resource 'Documentation page', specifying which fields (title, descriptionHtml, metaDescription). Distinguishes from sibling 'easytopic_create_doc_page' as an update operation.

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?

Provides precondition (bot must be project participant) and references sibling for checking participation. Implies use case via 'Updates', but lacks explicit when-not or alternatives.

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