ghl_product_update

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

Annotations indicate this tool is a mutation (readOnlyHint=false) but not destructive (destructiveHint=false) and idempotent (idempotentHint=true). The description adds context by specifying the HTTP method (PUT), endpoint path, and required OAuth scopes ('products.write'), which is beyond the annotations.

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 relatively concise, but it redundantly restates the tool name 'Update Product by ID' in the title and first sentence. The endpoint and OAuth scope details are useful but could be more integrated. Overall, it is appropriately sized with minimal waste.

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?

The tool has a complex input schema with many optional fields, but the description provides enough context for a standard update operation. There is no output schema, so the description does not explain return values, but the update operation's typical behavior is implied. The description is adequate for an agent to understand the tool's purpose.

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% coverage with descriptions for all parameters. The tool description does not add any additional meaning beyond what is already in the schema, so the baseline score of 3 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?

Clearly states 'Update Product by ID' and explains it modifies information for a specific product using its unique identifier. The verb is specific (update) and the resource is clearly identified as a product, distinguishing it from sibling tools like ghl_product_create, ghl_product_get, etc.

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 implies usage for updating a single product by ID, but does not explicitly state when to use this tool versus alternatives (e.g., creating, deleting, or listing products). No exclusion criteria or context for when not to use it is provided.

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