Get Integrations

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

Annotations already declare readOnlyHint=true and idempotentHint=true, so the safety profile is known. The description adds conceptual context about what integration instances are but no additional behavioral details like pagination or output structure, which would be useful.

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 concise but has redundancy, repeating 'Itential Platform' and 'integration instances' across the first two sentences. It could be tightened to a single sentence without loss of meaning.

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 presence of an output schema and read-only annotations, the description sufficiently covers the tool's purpose and filter behavior. It does not need to explain return values, though adding an example or clarifying behavior with no filter would make it more complete.

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 100% coverage for the 'model' parameter. The description enhances this by explicitly stating 'optional model filtering,' adding semantic clarity that the parameter acts as a filter on the returned instances.

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 it retrieves 'all integration instances' with optional filtering, using a specific verb and resource. It distinguishes from sibling tools like get_integration_models by focusing on instances rather than models.

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 implies usage for listing integration instances but does not explicitly mention when to use this over alternatives such as get_integration_models or get_adapters. No exclusions or alternative recommendations are provided.

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