ghl_invoice_schedule_set_auto_payment

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

Annotations already indicate readOnlyHint false, so the mutation nature is clear. The description adds the OAuth scope requirement (invoices/schedule.write) and endpoint information, which are behavioral constraints. However, it does not disclose side effects (e.g., whether settings are overwritten or merged) or confirm the behavior of the 'enable' field.

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 short (4 lines) but contains redundancy: the first two lines essentially repeat 'Manage Auto payment for an schedule invoice'. The endpoint and scope info are useful though. It is front-loaded with the purpose, but conciseness could be improved by removing the duplicate sentence.

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?

Despite the complex nested body parameter and no output schema, the description does not explain what the tool returns (e.g., success indicator, updated configuration). It also omits any example usage or clarification on how to enable vs disable auto payment. For a tool with no output schema and nested objects, this is incomplete.

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 description coverage is 100%—every parameter in the input schema has a description. The tool description adds no additional parameter meaning beyond what the schema provides. According to guidelines, baseline is 3 for high coverage, so this score is appropriate.

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 it manages auto payment for a schedule invoice, which aligns with the tool name 'set_auto_payment'. It specifies the resource (auto payment) and action (manage), but 'manage' is slightly vague; an explicit verb like 'enable/disable' would be stronger. It is distinct from sibling invoice schedule tools (e.g., create, update) due to the focus on auto payment.

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?

No guidance is provided on when to use this tool versus alternatives like ghl_invoice_schedule_update or ghl_invoice_schedule_create. There is no mention of prerequisites (e.g., the schedule must exist) or exclusions. The description merely describes the tool without contextual usage advice.

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