ghl_saas_get_locations_by_stripe_id_deprecated

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint. The description adds important context about deprecation, required token type, and endpoint version, which is beyond what annotations provide. No contradictions.

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 has some redundancy (e.g., deprecation stated twice, similar sentences repeated). Although clear, it could be more concise by merging the first two lines.

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?

With no output schema and the openWorldHint annotation, the description does not mention what the response contains (e.g., fields, pagination). This leaves the agent uncertain about the return structure, which is a significant gap.

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 100% description coverage. The description adds value by clarifying that customerId and subscriptionId are Stripe-specific and that they are used in conjunction with companyId, reinforcing the schema's meaning without redundancy.

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 is deprecated and superseded, specifies it retrieves locations by stripe ID or customer/subscription ID, and provides the endpoint URL. The sibling tool ghl_saas_get_locations likely serves as the replacement, making the differentiation explicit.

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 marks the tool as deprecated and names the superseding endpoint ('GET /saas/locations'). Also states the required token level ('AGENCY-LEVEL (Company) TOKEN'), giving clear guidance on when to avoid using this tool.

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