Skip to main content
Glama

List modules

list_modules
Read-onlyIdempotent

Lists every module in a learning design by course and sequence with its id, giving the usual entry point into a design. Use a module id with module_coverage, alignment_gaps or module_content.

Instructions

Every module in the design, by course and sequence, with its id: the usual way into a design. Pass a module's id to module_coverage, alignment_gaps or module_content.

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": "list_modules"
  }
}

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.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive and closed-world, so the safety profile is covered. Beyond that, the description adds genuinely behavioral detail about the result shape: modules are ordered by course and sequence and each carries an id. It omits pagination/result-size behavior, which keeps it from a 5.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short sentences, both front-loaded: the first establishes what is returned, the second tells the agent what to do with it. No redundant restatement of the title or annotations.

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 zero-required-parameter list tool with no output schema, the description covers the essential return content and the follow-up path. It leaves the ref/branch selection story entirely to the schema, which is reasonable, though a note that it reads the default branch by default would round it out.

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%, and both the ref/branch parameters and their mutual exclusivity are documented there. The description says nothing about ref or branch, so it adds no meaning beyond the schema; baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description names the resource ('every module in the design'), the ordering ('by course and sequence'), and the key payload ('with its id'), so the agent knows exactly what it gets back. The phrase 'the usual way into a design' also distinguishes it from siblings that consume module ids rather than produce them.

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 explicit entry-point guidance ('the usual way into a design') and routes the agent onward by naming the three tools that accept a module id. It stops short of stating when NOT to use it, or how it relates to list_branches/other lookups, so it is clear but not fully exhaustive.

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