cancel_visit

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

No annotations are provided, so the description must fully convey behavioral traits. It describes the action and return value but omits side effects, permissions required, or failure modes (e.g., whether cancellation is reversible or allowed after certain states). This is insufficient for a mutation tool.

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 well-structured with a clear purpose first, then usage guidance, then parameter explanations. It avoids redundancy and front-loads the action. Slightly verbose in parameter details but efficient overall.

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?

No output schema or annotations exist, so completeness relies on the description. It covers how to get parameters, what the tool does, and what it returns ('raw API response'). However, it lacks details on error handling, idempotency, or constraints (e.g., cancellation window). Adequate but not thorough.

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% description coverage, but the description explains each parameter's meaning: visit_id (from creation), apartment_id (from get_user_multiprofile_info), and fields (dot-notation filtering). It adds significant context beyond the 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 cancels a pre-approved visit by visit ID, using a specific verb and resource. It distinguishes from sibling tools (list_expected, list_visits) which handle listing, not cancellation.

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 explicitly says when to use it (user wants to cancel a delivery approval) and provides step-by-step instructions for obtaining required IDs from get_user_multiprofile_info. It lacks explicit when-not-to-use or alternatives, but the guidance is clear.

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