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). Ranked/limit mode includes non-covered plan scenarios even when no SmartTests are linked (folderPath plans or plans/stories|scenarios). Server excludes verification_strategy=manual by default (autoVerificationOnly).

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get-requirement-coverage"
  }
}

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.7/5.0
Behavior4/5

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

Annotations already establish readOnly/idempotent/non-destructive, and the description adds real behavior beyond that: cross-branch aggregation dedupes branch copies and execution jobs by a stable hash of tests-root-relative path + test name, and the server excludes verification_strategy=manual by default via autoVerificationOnly. It also discloses that ranked/limit mode includes non-covered plan scenarios even with no linked SmartTests. It stops short of describing pagination or result caps beyond the limit parameter.

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?

It is front-loaded with the core purpose in the first sentence, and every clause is substantive. However, it is a single dense paragraph of chained parentheticals ('aggregates branch copies; execution jobs deduped by...', 'folderPath plans or plans/stories|scenarios') that an agent must parse in one pass; it would scan far better as short enumerated points.

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 nested objects and no output schema, the description covers the high-value knobs and hints at the response ('prefer response rankedScenarios (gaps only)'). It leaves the agent guessing about timeWindow, release, environment and recordTypes, and doesn't characterize the base coverage payload when ranked mode isn't used.

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 only 12% across 17 parameters, so the description has to carry the load; it explains scope.filePaths/folderPath roots, branchName, platform, limit, scenarioLifecycleStatuses, considerScenarioPriority, considerSemanticCoverage and autoVerificationOnly. Roughly half the parameters (release, branchId, timeWindow, environment, recordTypes, includeNonCoveredUserStories, includeNonCoveredTestScenarios) get no meaning from either the schema or the description. Useful partial compensation, but an incomplete one.

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?

The description opens with a specific verb and resource: 'Fetch requirement (scenario) coverage under an optional platform-rooted folder scope (tests/... or plans/...).' That defines scope and units well enough to distinguish it from broad read siblings like get-test-scenarios or get-qa-posture. It never names a sibling or an explicit alternative, so the differentiation is implied 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?

It gives concrete operational guidance: omit branchName for cross-branch coverage, pass it only when results must be limited to one branch; use platform to filter the rollup; set scenarioLifecycleStatuses plus considerScenarioPriority/considerSemanticCoverage and limit for top-N gaps. What's missing is when to choose this tool over siblings such as get-requirement-quality-report or list-test-scenarios-for-scope.

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.