crm_prepare_change

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

Without annotations, the description must fully disclose behavior. It states 'non-mutating,' indicating no side effects, and mentions hashing, suggesting a change set is prepared and hashed without persistence. However, it lacks details on error handling, permissions, or what constitutes a valid request. Adequate but incomplete.

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 very short (one sentence). While concise, it sacrifices informative value. For a tool with one parameter and no annotations, a slightly longer description that adds parameter guidance would be more beneficial without being verbose.

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?

Given the tool's complexity (nested object parameter, no output schema, multiple siblings), the description is insufficient. It does not explain the hash's purpose or how the output should be used. Sibling tools exist but are not referenced for comparison.

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%. The single parameter 'request' is an object with additionalProperties: true, but the description provides no explanation of its expected structure, fields, or constraints. For a parameter-heavy tool, this is a critical gap.

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's action ('prepare and hash') and object ('non-mutating create or update change set'). It distinguishes from sibling tools by specifying 'non-mutating', implying no data modification. However, the phrase 'non-mutating create or update' is slightly contradictory and could be clearer.

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 on when to use this tool versus its siblings (e.g., crm_get, crm_search). No mention of prerequisites, when not to use, or alternatives. The description only states what the tool does without context for decision-making.

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