Skip to main content
Glama

Build a requirement traceability matrix

delivery_traceability_matrix
Read-only

Build a requirements traceability matrix by mapping Jira issue requirements and acceptance criteria to changed files, then flag gaps for review.

Instructions

Build a requirements traceability matrix: map each requirement and acceptance criterion of a Jira issue to the changed files that implement it, and flag gaps. Fetches the issue itself. For a ready-for-PR verdict use delivery_check_changes.

Input Schema

NameRequiredDescriptionDefault
issueKeyYesJira issue key (e.g. PROJ-123)
repoPathNoPath to the git repository.
baseBranchNoBase branch to diff againstorigin/main
compareRefNoBranch or commit to compareHEAD
includePrDiffNoMatch requirements against the local diff
includeConfluenceNoInclude requirements found in Confluence

Output Schema

NameRequiredDescriptionDefault
toolYes
issueKeyNo
markdownYes
warningsYes
schemaVersionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint and openWorldHint, so safety is covered. The description adds genuinely new behavioral context: it performs its own issue fetch (explaining the open-world hint) and produces gap flags rather than a pass/fail verdict. It doesn't mention that the default includeConfluence=true triggers a second external system, which would have been a useful disclosure.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences plus a short routing sentence, with the core purpose front-loaded and zero filler. Each clause carries distinct information: what is built, what it maps, that it self-fetches, and which sibling to use instead.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists (return values needn't be explained) and annotations cover the safety profile, so the burden is light. The description covers purpose, the self-fetch behavior, and sibling routing; the only missing piece is that Confluence is queried by default, which affects latency and scope for an open-world tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so all six parameters including baseBranch/compareRef/includePrDiff/includeConfluence are already documented. The description only reinforces that the diff comparison and requirement set are the core inputs; it adds no syntax, defaults, or interaction details beyond the schema, so baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and artifact ("Build a requirements traceability matrix") plus the exact operation: map each requirement and acceptance criterion of a Jira issue to changed files and flag gaps. It also names a sibling (delivery_check_changes) and contrasts its output, so an agent can distinguish the two without opening either schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly routes the agent: use delivery_check_changes for a ready-for-PR verdict, this one for a gap-flagged matrix. It also clarifies an important prerequisite is handled internally ("Fetches the issue itself"), so the caller doesn't need jira_get_issue first. No explicit when-not conditions beyond that single alternative, so not a 5.

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