Generate a Signal Forms migration report

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

The description clearly discloses that the tool is read-only and does not write files, which aligns with and adds context beyond the readOnlyHint annotation. It also explains that the report is returned as a string and that saving it is the caller's decision, which is useful behavioral guidance for an agent.

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 reasonably concise and front-loaded with the core action. It packs useful details into three sentences, but it has some redundancy: 'it does NOT write a file', 'you decide whether to save it', and 'this tool never modifies your files' all express similar read-only/no-file-write behavior.

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 complete for a read-only reporting tool of this complexity. It names the input scope, the output format, the report contents, and the file-writing behavior. Since an output schema exists and annotations cover read-only behavior, nothing critical is missing for an agent to decide whether to call this tool.

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 already documents the `path` parameter as an absolute path to a .ts file or directory. The description adds context by mentioning .html files and directories, but it does not materially expand the parameter semantics beyond what the schema describes. With 100% schema coverage, a baseline score of 3 is appropriate.

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 identifies what the tool does: it scans .ts and .html files or a directory and returns a Markdown report with specific content (findings, complexity, file order, recipe names, version warnings). It distinguishes the tool from generic utility tools by naming the report contents, though it stops short of explicitly contrasting itself with the sibling analysis tools.

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 when to use this tool: when you need a combined migration report as a string rather than a file. It does not explicitly state when not to use it or which sibling tool should be used instead, such as `analyze_migration_complexity` for complexity-only analysis or `verify_migration` for validation afterward.

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