zulip

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

With no annotations provided, the description carries the full burden and does well by disclosing key behaviors: it triggers a user-facing indicator, auto-clears when a message is sent, and returns a confirmation or error. It could improve by mentioning any rate limits or permissions needed, but covers the core operational traits adequately.

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 front-loaded with the core purpose in the first sentence, followed by specific usage guidelines. Every sentence earns its place by adding critical information without redundancy, making it efficient and well-structured for quick comprehension.

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 low complexity (0 parameters, no annotations), the description is complete: it explains what the tool does, when to use it, behavioral details (auto-clear, returns confirmation), and an output schema exists for return values. No gaps are present for this simple utility tool.

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?

The input schema has 0 parameters with 100% coverage, so no parameter documentation is needed. The description adds value by explaining the implicit context ('current conversation') and usage timing, which compensates for the lack of parameters. A baseline of 4 is appropriate as it provides meaningful context beyond the empty 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 tool's purpose with a specific verb ('Send') and resource ('typing indicator in the current conversation'). It distinguishes itself from siblings like 'stop_typing' by focusing on starting the indicator, and from 'reply' or 'listen' by specifying it's for preparatory work rather than message posting.

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 guidance on when to use ('before heavy tool work') and when not to use ('Do NOT call before reply() or listen()'). It also mentions alternatives by name (e.g., 'reply() or listen()') and specifies the context ('stretches of work where you won't be posting for a while').

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