Skip to main content
Glama

Report Requirement Quality Findings

report-requirement-quality-findings

Upload a DeFOSPAM / requirement quality analysis report for a user story or test scenario (local-agent path). Pass full RequirementQualityReport JSON via --report-file or --json-input {"report":{...}}. report.subject.subjectEntityId is required; use --subject-type + --ordinal-id to resolve via get-requirement-quality-report, or set subjectEntityId explicitly. Backend merges IGNORED/APPLIED findings carry-forward on re-report.

Input Schema

NameRequiredDescriptionDefault
botIdNoQA bots: your botId from your stored TestChimp binding.
reportNo
ordinalIdNo
reportFileNo
subjectTypeNo
projectApiKeyNoQA bots: your own project API key from your stored TestChimp binding. Required on every call except get-bot-credentials, get-project-credentials and get-bot-compat. Never print it.
subjectEntityIdNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changed
    • addedInput schema / properties / report / properties / createdAtMillis / anyOf
      Added value: +[
      +  {
      +    "minLength": 1,
      +    "type": "string"
      +  },
      +  {
      +    "type": "number"
      +  }
      +]
    • removedInput schema / properties / report / properties / createdAtMillis / type
      Removed value: -"number"
    • addedInput schema / properties / report / properties / findings / items / properties / linkedIssueOrdinalId
      Added value: +{
      +  "maximum": 9007199254740991,
      +  "minimum": -9007199254740991,
      +  "type": "integer"
      +}
    • addedInput schema / properties / report / properties / scoresUpdatedAtMillis / anyOf
      Added value: +[
      +  {
      +    "minLength": 1,
      +    "type": "string"
      +  },
      +  {
      +    "type": "number"
      +  }
      +]
    • removedInput schema / properties / report / properties / scoresUpdatedAtMillis / type
      Removed value: -"number"
  2. Changed2 schema fields changed
    • addedInput schema / properties / botId
      Added value: +{
      +  "description": "QA bots: your botId from your stored TestChimp binding.",
      +  "maxLength": 64,
      +  "minLength": 1,
      +  "type": "string"
      +}
    • addedInput schema / properties / projectApiKey
      Added value: +{
      +  "description": "QA bots: your own project API key from your stored TestChimp binding. Required on every call except get-bot-credentials, get-project-credentials and get-bot-compat. Never print it.",
      +  "maxLength": 256,
      +  "minLength": 8,
      +  "type": "string"
      +}
  3. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations declare a non-read-only, non-destructive, non-idempotent write; the description adds genuinely non-obvious behavior beyond that: the backend merges IGNORED/APPLIED findings carry-forward on re-report, which changes what a repeat call does. It doesn't say what the call returns or whether submission can be rejected, but the merge semantics are the key hidden trait and are disclosed.

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

Conciseness3/5

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

Three dense sentences with the key requirement (subjectEntityId) correctly placed early, but the CLI flag syntax (--report-file, --json-input) clashes with the tool's JSON-object interface and forces the reader to translate. Every sentence carries information, yet the phrasing could be tighter.

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?

Covers input construction and re-report merge semantics, which is the hardest part of this complex nested schema. However, with no output schema there is no statement of what a successful report returns (report id, merged finding counts) or error conditions, leaving a real gap for an agent that needs to confirm the upload.

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

Parameters4/5

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

With only 29% schema description coverage across 7 params including a deep nested report object, the description must compensate and largely does: it names the report payload, both input channels (report-file / json-input with {report:{...}}), the required subjectEntityId, and the subjectType+ordinalId resolution path. botId and projectApiKey rely on their schema descriptions, which is acceptable.

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+resource: uploading a DeFOSPAM/requirement quality analysis report for a user story or test scenario, and pins the flow to the local-agent path. This distinguishes it from the read-side sibling get-requirement-quality-report, which it references. The 'DeFOSPAM' jargon and CLI-flag phrasing slightly obscure the purpose for an agent working purely with JSON.

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 precondition (report.subject.subjectEntityId is required) and an explicit alternative path: resolve via --subject-type + --ordinal-id through get-requirement-quality-report, or set subjectEntityId explicitly. It lacks an explicit 'do not use this to read/fetch reports' exclusion, but the routing between this tool and its read-side sibling is clear.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.