Skip to main content
Glama

A module's coverage

module_coverage
Read-onlyIdempotent

Evaluates how well a module's assessments cover its declared objectives, returning per-objective coverage verdicts from distinct item counts and approved versus projected delivery.

Instructions

How well a module's assessment covers the objectives it declares: for each objective, a verdict (Uncovered, PartiallyAssessed, FullyAssessed, OverAssessed) from the number of distinct items assessing it in the module's own assessments. Coverage counts approved items in approved placements, what students meet; projected counts every item and placement not retired, what the module will deliver once drafts are cleared. Each declaration carries its role and the rationale for it. Computed at the commit read, never stored.

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": {
      "moduleId": "<moduleId>"
    },
    "name": "module_coverage"
  }
}

Input Schema

NameRequiredDescriptionDefault
refNoA commit id to read at, as an earlier answer named it: pass the commit from your first answer to every follow-up, so the conversation reads one state of the design. Pass this or branch, not both.
branchNoThe branch to read at its latest commit. Leave out to read the default branch (main unless configured otherwise). Pass this or ref, not both.
moduleIdYesThe module's id, as Module/local or the local part alone; list_modules gives them.
fullyAssessedAtNoDistinct eligible items at which an objective is FullyAssessed; the hub's setting (2 unless configured) when left out.
overAssessedAboveNoDistinct eligible items above which an objective is OverAssessed; the hub's setting (4 unless configured) when left out.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, closed-world behavior, so the bar is lower, yet the description still adds real substance: verdicts are derived from distinct-item counts, coverage counts only approved items in approved placements while projected includes non-retired drafts, and results are computed at read time and never stored. That last point is a meaningful, non-obvious guarantee for an agent reasoning about freshness.

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?

The purpose is front-loaded in the first clause and each following sentence carries distinct information (verdict basis, counting modes, declaration contents, computation timing). It is dense and clause-heavy but contains no filler or repetition.

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?

With no output schema, the description does the work of describing returns: per-objective verdicts, distinct-item counts, roles, and rationales. The one real gap is that it explains two counting modes without saying how the caller selects between them, which matters for a tool whose whole value is that comparison.

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 100%, so the schema already documents ref, branch, moduleId, fullyAssessedAt and overAssessedAbove, making 3 the baseline. The description adds the conceptual basis for the two threshold parameters ('from the number of distinct items assessing it') but never maps the coverage/projected distinction to any actual parameter, leaving the agent to infer how to request each mode.

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 opening clause states a specific resource and computation: how well a module's assessment covers the objectives it declares, with named verdicts (Uncovered, PartiallyAssessed, FullyAssessed, OverAssessed). The module scope implicitly separates it from course_coverage, but it never names that sibling or any other alternative explicitly.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is implied rather than stated: the coverage-vs-projected explanation ('what students meet' vs 'what the module will deliver once drafts are cleared') gives the agent a reason to pick one counting mode or the other. There is no explicit when-to-use, when-not, or named alternative to route against siblings like course_coverage or alignment_gaps.

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