Skip to main content
Glama
Sign In

TestChimp

by io.testchimp
OverviewDiscussionsAdmin

Get Requirement Quality Report

get-requirement-quality-report
Read-onlyIdempotent

Fetch the stored requirement quality report (metrics + findings with user states) for a user story or test scenario. Use before local DeFOSPAM to dedupe: do not re-report findings already IGNORED or APPLIED (match by fingerprint). Pass subjectType STORY|SCENARIO plus subjectEntityId or ordinalId (numeric part of US- / TS-). When no prior report exists, response still includes report.subject with resolved subjectEntityId.

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": {
      "subjectType": "<subjectType>"
    },
    "name": "get-requirement-quality-report"
  }
}

Input Schema

NameRequiredDescriptionDefault
botIdNoQA bots: your botId from your stored TestChimp binding.
ordinalIdNo
subjectTypeYes
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. 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"
+}
  2. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, so the bar is lower, yet the description still adds real behavior: the return payload shape (metrics + findings with user states), the fingerprint-based dedupe rule, and the empty-state guarantee that report.subject is still returned. It does not cover pagination or size limits, keeping it out of the top band.

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 sentences, front-loaded with what is fetched before the workflow caveat and the parameter syntax. Dense with no filler, though the unexplained 'DeFOSPAM' acronym briefly costs the reader clarity.

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?

For a read-only fetch tool whose annotations carry the safety profile and which has no output schema, the definition supplies purpose, the dedupe workflow, parameter decoding, and the empty-result case. Sufficient to call correctly; only return-format depth (size, paging) is absent, which is minor here.

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 40% schema coverage, the description does meaningful compensatory work: it explains subjectType's STORY|SCENARIO split, the either/or between subjectEntityId and ordinalId, and decodes ordinalId as 'the numeric part of US-<n> / TS-<n>'—none of which the schema states. botId and projectApiKey remain explained only in the schema.

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+scope: 'Fetch the stored requirement quality report (metrics + findings with user states) for a user story or test scenario.' This cleanly separates it from get-requirement-coverage, but it never explicitly names that sibling or any other, so an agent must infer the distinction from the resource noun alone.

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 concrete when-to-use ('Use before local DeFOSPAM to dedupe') and a when-not condition ('do not re-report findings already IGNORED or APPLIED'). This implies the downstream reporting tool but does not name it, so routing is clear by context rather than explicit alternative naming.

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

All TestChimp toolsInspect
Try in Browser
Claude Code, inside the Godot 4 editorFlockbay puts an AI agent in the real Godot 4 editor: it writes GDScript, runs your game and fixes what breaks. Free, or bring your own Claude Code or Codex.flockbay.comAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources