Update App Installation

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

The description states that 'only the supplied fields are changed' and that it returns the modified object, adding some behavioral context beyond the annotations. However, annotations already indicate non-destructive and non-read-only behavior; the description does not disclose authorization requirements, side effects, or rate limits.

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 with two main sentences and a list of required parameters. It is front-loaded with the primary action. However, the parameter list is redundant with the schema, slightly impacting conciseness.

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 description adequately covers the tool's purpose and basic behavior. It mentions the API endpoint and return value ('modified object'). For a simple update tool with no output schema, this is sufficient, though it could improve by noting that it's not idempotent (consistent with annotations).

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%, so the description adds little value here. The list of required parameters simply repeats schema fields without providing additional semantic meaning or usage context beyond what the schema already offers.

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 action ('update the status') and the resource ('App Marketplace records'), differentiating it from the create sibling. It specifies the verb-update and the resource, making the purpose unambiguous.

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 indicates when to use this tool ('to update an existing App Marketplace records') but does not explicitly exclude alternatives or specify when not to use it. Listing required parameters provides some guidance, but lacks direct comparison with related tools.

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