pause_survey

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

Discloses that in-flight responses continue, new tasks stop, and errors occur for inactive surveys. No annotations present, but it covers key behaviors. Could mention reversibility via resume_survey.

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?

Concise and well-structured: first line states purpose, then explains behavior and errors. 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 essential aspects for a simple tool: purpose, side effects, error conditions, and parameter source. Lacks prerequisites or permissions, but output schema exists and is separate.

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?

Job_id parameter is explained as 'The job ID returned by create_survey', which adds meaning beyond the schema. Despite 0% schema coverage, the description compensates adequately.

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 pauses task serving for an active survey, differentiating it from siblings like resume_survey and cancel_survey. It specifies that in-flight responses continue while new tasks stop.

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 clear context on when to use (to pause an active survey) and warns of 400 errors for invalid states. However, lacks explicit alternatives or when-not-to-use guidance beyond error conditions.

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