Skip to main content
Glama

A course's coverage

course_coverage
Read-onlyIdempotent

Get per-module coverage for a course in sequence order, or for every module in a design when no course is named. Use it as an overview before inspecting a single module.

Instructions

module_coverage for every module of a course, in sequence order, or for every module in the design when no course is named: the overview before looking at one module.

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": "course_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.
courseNoThe course's id, as Course/local or the local part; every module in the design when left out.
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.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so the safety profile is fully covered structurally. The description adds only the ordering guarantee ("in sequence order") and the design-wide fallback scope. It says nothing about response size for large designs, or how the assessment-threshold settings affect the reported coverage.

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?

A single front-loaded sentence with no filler, and the most decision-relevant element (the module_coverage analogy) comes first. The colon-and-appositive construction is dense enough that it takes a second read to parse, which costs it a point.

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?

There is no output schema, so the description is the only source for return shape, and it conveys that indirectly via the module_coverage analogy plus sequence ordering. With five optional parameters and no annotations gaps, the remaining omission is that nothing describes the payload's structure or size for a whole-design query.

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, course, fullyAssessedAt and overAssessedAbove. The description only restates the course-omitted behavior that the schema's own course description already gives ("every module in the design when left out"). Baseline 3 applies since the schema carries parameter meaning.

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 names the resource (a course's coverage) and defines it explicitly as the aggregate form of a named sibling: "module_coverage for every module of a course, in sequence order." An agent can distinguish batch coverage from the single-module tool without opening either schema. It stops short of a clean verb+resource statement, reading as a fragment rather than a full sentence.

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?

"the overview before looking at one module" gives an explicit ordering of use: start here, then drill into module_coverage. It also states the no-course case (every module in the design), which is a usage condition. What's missing is any explicit statement of when NOT to use it, e.g. when you already know the single module you care about.

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