Update set create

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

Annotations already declare readOnlyHint=false, idempotentHint=false, destructiveHint=false, and openWorldHint=true, so the mutation profile is covered structurally. The description adds real value beyond that by naming the persistence target table and disclosing the MissingParameterError failure mode, but says nothing about permissions, side effects on scope/application state, or whether re-creation is possible.

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 opening sentence is front-loaded and the docstring is ordered logically (purpose, params, return, raises). However, the :param/:type pairs are boilerplate that restate names with type info already inferable from the schema, and the block is longer than the effective information content warrants.

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?

For a mutation tool exposing 43 parameters with zero schema coverage and no output schema, the description leaves most of the surface unexplained — an agent cannot know what most parameters do or which matter for a typical call. The return statement is a generic 'parsed Pydantic model' with no description of the contained fields, and no output schema exists to compensate.

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 0% across 43 parameters, so the description carries the full burden — yet it documents only 4 of them (update_set_name, description, scope, sys_id). It does flag the required-name and scope/sys_id-either-or rules, which the schema marks as optional/nullable, but the remaining ~39 parameters (packages, repo_url, branch_name, rollback_id, etc.) are unexplained in both schema and description.

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 states a specific verb and resource — 'Creates a new update set' — and even names the target table (sys_update_set), so the agent knows exactly what object is produced. It does not, however, distinguish itself from the sibling update-set tools (commit, preview, retrieve, back_out, commit_multiple), which all share the same resource.

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?

Usage context is only implied through the :raises block, which tells the agent that update_set_name is mandatory and that either sys_id or scope must be supplied — genuinely useful invocation constraints. There is no statement of when to prefer this tool over the sibling update-set operations, so the when-vs-alternatives guidance is missing.

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