replace_topics

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

No annotations provided, but description fully discloses destructive nature: every existing topic not listed is removed. Also covers topic name format constraints and the effect of empty array. No contradiction.

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?

Description is single paragraph but well-structured: purpose first, then behavior, format constraints, and usage tips. Every sentence adds useful information with no redundancy.

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?

Given no output schema and moderate complexity (3 params, required 1), description covers all necessary aspects: operation, safety precautions, format rules, and implicit return (success/failure not needed for replace). Complete for intended use.

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 covers 100% of parameters with descriptions, but description adds value by clarifying that 'topics' list is what should remain after call and reiterating format rules. Provides context beyond schema: reading existing topics and confirming with user.

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?

Description explicitly states 'REPLACE a repository's ENTIRE topic set', clearly identifying the action (replace) and resource (topic set). Distinguishes from siblings like add_topic and remove_topic by specifying it's a full replacement.

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?

Explicit guidance provided: read current topics with list_topics first if any must survive, confirm with user before replacing, and pass empty array to clear all topics. Clearly indicates when not to use (without preserving existing topics) and suggests alternative (list_topics).

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