Skip to main content
Glama

Get Requirement Coverage

get-requirement-coverage
Read-onlyIdempotent

Fetch requirement (scenario) coverage under an optional platform-rooted folder scope (tests/... or plans/...). Use scope.filePaths or scope.folderPath (platform tests/plans roots). Omit branchName for cross-branch coverage (aggregates branch copies; execution jobs deduped by stable hash of tests-root-relative path + test name). Pass branchName only when results must be limited to one Git branch. Optional platform (web|ios|android) filters rollup. For top-N gap recommendations: set scenarioLifecycleStatuses, considerScenarioPriority / considerSemanticCoverage, and limit; prefer response rankedScenarios (gaps only). Server excludes verification_strategy=manual by default (autoVerificationOnly).

Input Schema

NameRequiredDescriptionDefault
botIdNoQA bots: your botId from your stored TestChimp binding.
limitNo
scopeNo
releaseNo
branchIdNo
platformNo
branchNameNo
timeWindowNo
environmentNo
recordTypesNo
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.
autoVerificationOnlyNo
considerScenarioPriorityNo
considerSemanticCoverageNo
scenarioLifecycleStatusesNo
includeNonCoveredUserStoriesNo
includeNonCoveredTestScenariosNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / branchId
      Added value: +{
      +  "anyOf": [
      +    {
      +      "minLength": 1,
      +      "type": "string"
      +    },
      +    {
      +      "type": "number"
      +    }
      +  ]
      +}
    • addedInput schema / properties / timeWindow
      Added value: +{
      +  "properties": {
      +    "fixedWindow": {
      +      "properties": {
      +        "endTime": {
      +          "minLength": 1,
      +          "type": "string"
      +        },
      +        "startTime": {
      +          "minLength": 1,
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "startTime",
      +        "endTime"
      +      ],
      +      "type": "object"
      +    },
      +    "relativeWindow": {
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  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.9/5.0
Behavior4/5

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

Annotations already establish read-only, idempotent, non-destructive behavior, and the description adds real semantics on top: cross-branch results aggregate branch copies and execution jobs are deduped by a stable hash of tests-root-relative path + test name, and manual verification records are excluded by default. That default-exclusion behavior is exactly the kind of hidden filter an agent needs and wouldn't get from annotations.

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?

It is a single front-loaded paragraph that opens with purpose and moves to the highest-value decision (branchName) before tuning knobs. Density is high and every clause carries information, though the run-on packing of parameter names makes it harder to scan than a short bulleted structure would.

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 17-parameter tool with no output schema, the description covers scope/branch/dedup defaults but says almost nothing about the response beyond pointing at rankedScenarios for gap mode. An agent still cannot tell what a non-gap-mode response looks like, how limit interacts with pagination, or how release/environment/timeWindow narrow results.

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 schema coverage at 12% across 17 parameters, the description carries most of the burden and does explain the important ones: scope.filePaths/folderPath roots, branchName's all-branches vs single-branch tradeoff, platform filtering, the gap-recommendation knobs, limit, and autoVerificationOnly. Gaps remain for branchId vs branchName, release, environment, timeWindow, recordTypes, and the includeNonCovered* flags.

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 ('fetch requirement (scenario) coverage') plus the scoping model (platform-rooted tests/... or plans/... folders), which is far more informative than the title alone. It does not explicitly contrast itself with adjacent siblings such as get-requirement-quality-report or get-test-scenarios, so an agent must infer the boundary.

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 conditional guidance: omit branchName for cross-branch aggregation, pass branchName only when limiting to one Git branch, and set scenarioLifecycleStatuses/priority/semantic flags plus limit when you want top-N gap recommendations. No alternative tools are named and no when-not-to-use cases are stated, so it stops short of a 5.

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.