Create change request ci association

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

Annotations already declare readOnlyHint=false, idempotentHint=false, openWorldHint=true and destructiveHint=false, so the safety profile is covered. The description adds real value beyond that by disclosing the three required inputs, the valid association_type values ('affected, impacted, offering'), the conditional relevance of refresh_impacted_services, and the error classes raised. It does not say whether repeated calls duplicate associations, which matters for a non-idempotent write.

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 purpose is front-loaded and the docstring-style block is organized into params/return/raises, which aids scanning. However, the ':type' lines merely restate type information already present in the schema, adding length without adding meaning, and the return/raises sections are somewhat verbose relative to the information conveyed.

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 22-parameter mutation tool with no output schema and no schema descriptions, the definition leaves most parameters unexplained and does not clarify whether parameters like sysparm_limit, text_search, or state are even relevant here. Return handling is described only as a Pydantic model, which is helpful, but overall coverage is inadequate for the tool's complexity.

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 schema has 22 parameters with 0% description coverage, and the description documents only 4 of them (change_request_sys_id, cmdb_ci_sys_ids, association_type, refresh_impacted_services). The remaining 18 — data, state, sysparm_query, sysparm_limit, task_sys_id, and others — are undocumented in either the schema or the description, leaving a large gap the description should have filled.

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 first sentence states a specific verb and resource ('Create associations between a change request and configuration items'), which is clear and distinguishable from create_change_request and create_cmdb_relation. It does not, however, explicitly name those siblings or explain how the association differs from a CMDB relation.

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?

There is no when-to-use guidance, no prerequisites, and no mention of alternatives such as create_cmdb_relation or refresh_change_request_impacted_services. The agent must infer usage entirely from the tool name and the association_type example values.

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