ghl_saas_pause_location_deprecated

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

Description mentions auth requirement and deprecation but adds little beyond annotations. Annotations already indicate mutation (readOnlyHint=false) and non-destructive nature (destructiveHint=false). 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 functional but repetitive (deprecation notice appears twice). Could be more concise, but core information is present and accessible.

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 deprecation, authentication level, endpoint details, and required parameters. Lacks explanation of pausing effects, but given the tool's simplicity and annotations, it is sufficiently complete.

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 coverage is 100%, so baseline 3. Description restates the parameters (locationId, body) without adding new meaning or constraints 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?

Clearly states the tool pauses a location/subaccount, includes verb and resource. Deprecation and replacement are explicitly noted, distinguishing it from the newer ghl_saas_pause_location sibling.

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?

Explicitly states DEPRECATED and superseded by a specific endpoint, guiding agents to prefer the replacement. Also requires agency-level token, providing clear usage context.

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