generate_integration_guide

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

With no annotations, the description carries the full burden of disclosing behavior. It only states the action ('generate a guide') without mentioning whether it reads the provided header files, what output format it produces (e.g., Markdown, text), whether it writes to disk, or any side effects. This leaves significant behavioral ambiguity.

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 a single, well-structured sentence that front-loads the core purpose and includes relevant details (setup steps, code examples, best practices) without any fluff. It is efficiently sized.

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?

The description is too brief for a 5-parameter generation tool with no output schema. It omits crucial context such as the expected output format, dependency on valid header file paths, whether an existing Unreal project is required, and any potential read-only or write behavior. This leaves the agent uncertain about preconditions and return values.

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 input schema provides 100% coverage with descriptions for all parameters. The tool description adds minimal parameter-related context, referencing 'setup steps, code examples, and best practices' which loosely maps to includeCodeExamples and includeBlueprints, but does not meaningfully enhance the schema.

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 a specific verb ('Generate') and resource ('comprehensive integration guide for a system') and clearly distinguishes itself from sibling code-generation and documentation tools by focusing on integration into an Unreal Engine project with setup steps, code examples, and best practices.

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 makes the primary context clear: it is for generating an integration guide for an Unreal Engine project. However, it does not explicitly name alternatives or provide exclusion criteria, so it misses the full 'when not to use' guidance.

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