Skip to main content
Glama

req_add

Register a project requirement with testable acceptance criteria so evidence can link to it and verification or staleness is tracked as code changes.

Instructions

Register a requirement with acceptance criteria. Use when the user states a feature or a promise the project should keep. Criteria are auto-numbered R.; they are what evidence files link to.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "id": "<id>",
      "title": "<title>"
    },
    "name": "req_add"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYese.g. R9
filesNoglobs whose change makes this stale, e.g. ['server.py','web/**/*.js']
titleYes
criteriaNotestable statements, one per criterion

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.0

TDQS

A3.6/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the full burden. It does disclose non-obvious behavior: criteria are auto-numbered as R<n>.<i> and become the anchor that evidence files reference. It does not address write semantics such as what happens on a duplicate id, whether registration is idempotent, or what the call returns.

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

Conciseness4/5

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

Three tight sentences that lead with the action, then the trigger, then the ID/linkage behavior. Every sentence carries information; only the notation 'R<n>.<i>' is slightly cryptic without an example.

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

Completeness3/5

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

For a 4-parameter creation tool with no annotations and no output schema, the description covers purpose, trigger, and the criteria/evidence relationship adequately. It still omits the role of the files globs and any confirmation of what registration returns, which an agent would want before invoking.

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 coverage is 75%, with id, files, and criteria already documented in-schema, so the baseline is 3. The description adds real meaning about criteria (auto-numbered R<n>.<i>, and that evidence files link to them), but says nothing about the files globs or the title, leaving the added value partial.

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

Purpose4/5

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

States a specific verb and resource ('Register a requirement') plus the payload it carries ('with acceptance criteria'), which is enough to separate it from the read-oriented siblings (req_list, req_scope). It never names a sibling to contrast with, so discrimination is inferred rather than stated.

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?

Gives a concrete trigger: 'Use when the user states a feature or a promise the project should keep.' That clearly frames creation versus listing or scoping. It provides no exclusions (e.g., when to update an existing requirement via req_set_status instead), so the when-not side is missing.

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