explain_integration_pattern

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

With no annotations provided, the description carries the full burden and successfully discloses what the tool produces (message flow diagrams, expected segments, common pitfalls, best practices). This gives clear behavioral context about the output format. It does not clarify what [Premium] implies for access restrictions or rate limits, but covers the core behavioral traits.

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 efficiently structured with the [Premium] tag and main purpose front-loaded, followed by a comprehensive list of content deliverables and valid pattern names. Every element earns its place; there is no redundant or wasteful text.

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 single-parameter simplicity and lack of output schema, the description adequately compensates by detailing what the explanation will contain (diagrams, segments, pitfalls). For an educational tool of this scope, the description provides sufficient context for successful invocation, though it could note the output format structure.

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?

While the schema has 100% description coverage with examples, the description adds significant value by enumerating the complete set of valid pattern options (seven specific patterns) beyond the schema's limited examples. This compensates for the lack of enum constraints in the schema and guides the user toward valid inputs.

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 uses specific verbs ('Explain') and resources ('healthcare integration patterns') and explicitly enumerates included content types (message flow diagrams, trigger events, best practices). It clearly distinguishes from operational siblings like parse_hl7_message or pacs_query by focusing on architectural/educational content rather than data processing.

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 an implicit usage guide by listing the seven supported pattern names ('ADT feed', 'order to result', etc.), indicating the tool handles these specific scenarios. However, it lacks explicit when-to-use guidance comparing this educational tool against its siblings or stating prerequisites for the [Premium] designation.

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