Run a gap analysis

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

With no annotations, the description carries full behavioral burden, and it is highly transparent. It discloses that eliminations are always reported to preserve the cost-reduction case, that gaps are emitted as ready-to-paste add_work_package JSON, that save=true only appends a one-line summary without creating work packages, and that missing sources are rendered as 'no source' rather than blank.

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 information-dense and well structured: method, key guarantee, downstream integration, side effects, and provenance behavior are covered in order. The bilingual duplication makes it longer than strictly necessary, but each clause adds behavioral value and nothing is filler.

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?

This is a complex 7-parameter tool with no output schema and no annotations, yet the description explains the method, the matrix output, the gap categories, the recommended-action return, the add_work_package JSON emission, the save side effect, and the sources edge case. An agent has enough context to invoke the tool correctly and interpret its results.

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?

Schema description coverage is 100%, so the baseline is 3, and the description adds meaningful semantic value beyond the schema. It clarifies the behavior of sources (source column, 'no source' marker), the side effect of save (appends summary, does not create work packages), and the default mapping semantics for unmapped baseline elements (retained if same-named target exists, otherwise eliminated).

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 tool compares baseline and target elements, visualizes the mapping as a matrix, and derives gaps (new, eliminated, modified/replaced) with recommended actions. This is a specific verb+resource and meaningfully distinguishes gap_analysis from siblings like compare_with_togaf or cross_map.

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 use case is clearly implied: call this when you need a baseline-to-target gap analysis with a mapping matrix and gap list. However, the description never explicitly names alternatives or states when not to use this tool versus siblings like compare_with_togaf or cross_map, so the guidance is implied rather than explicit.

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