create_integration_model

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

No annotations are provided, so the description carries the full burden. It discloses that the input must be a valid OpenAPI specification, suggesting validation, but it does not mention permissions, side effects, overwrite behavior, or failure modes. The explanatory sentence about integration models is background context, not operational behavior. This is insufficient for a mutation tool without 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 two sentences, front-loaded with the action, followed by a brief explanation and a constraint. Every sentence earns its place; there is no fluff or redundancy.

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 single parameter and the presence of an output schema, the description is fairly complete. It explains what the tool does and the input requirement. It could add a note about how the model is named or what happens on invalid input, but the essential information for invoking the tool correctly is present. The output schema handles return value expectations.

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 describes the only parameter 'model' as 'OpenAPI specification', and the description adds that it must be a valid OpenAPI specification document. This adds a validity constraint beyond the schema, which is meaningful for the agent. With 100% schema coverage, the baseline is 3, and the added requirement justifies a 4.

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: 'Create a new integration model on Itential Platform from an OpenAPI specification.' It uses a specific verb and resource, and the source input is identified. This distinguishes it from sibling tools like get_integration_models (read vs. create) and other create tools by resource type.

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 provides clear context for when to use the tool: when you have an OpenAPI specification and need to create an integration model. It implies the input requirement ('from an OpenAPI specification') and even states the model must be a valid OpenAPI document. It does not explicitly mention alternatives or exclusions, but for a create operation the intended usage is fairly evident.

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