zulip

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

With no annotations provided, the description carries full burden and does well. It discloses key behavioral traits: the silent operation (no notification), the specific prefix-based resolve/unresolve mechanism, and the three propagation modes. It doesn't mention permissions, rate limits, or error conditions, but covers the core behavior adequately for a tool with no annotations.

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 appropriately sized and well-structured with clear sections (purpose, args, returns). Every sentence earns its place, though the parameter explanations could be slightly more concise. It's front-loaded with the core purpose and immediately distinguishes from alternatives.

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 the tool's moderate complexity, no annotations, 0% schema coverage, but with an output schema present, the description provides excellent completeness. It covers purpose, usage guidelines, parameter semantics, and behavioral context thoroughly. The output schema handles return values, so the description appropriately focuses on usage and parameters.

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?

With 0% schema description coverage, the description fully compensates by explaining all three parameters in detail. It provides the meaning of message_id (any message in topic, suggests how to find), topic (full new name with resolve/unresolve formatting rules), and propagate_mode (three options with clear explanations). This adds substantial value beyond the bare schema.

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 verb (rename) and resource (topic) with specific purpose: to mark topics as resolved/unresolved silently. It explicitly distinguishes from sibling 'move_messages' by stating 'Use this instead of move_messages when marking a topic as done,' providing clear differentiation.

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 explicit when-to-use guidance: 'Use this instead of move_messages when marking a topic as done.' It also specifies when-not-to-use by mentioning the silent nature (no notification created) and the specific resolve/unresolve use cases, giving clear alternatives and context.

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