Skip to main content
Glama

list modules

list_modules
Read-onlyIdempotent

Read module records in teaching order. Page with offset to inspect older modules or verify a module number before saving.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
offsetNo
programIdYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.7/5.0
Behavior4/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 covered. The description adds genuinely useful behavior beyond that: results are ordered by teaching sequence and are paged via offset, which tells the agent how to traverse the collection. Return payload shape is left to the output schema.

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, zero padding, and the core action plus the paging instruction are front-loaded. Every clause earns its place.

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 simple read-only list tool with an output schema (so return values need no explanation), the entry is mostly sufficient, but the unexplained required programId and the absence of any note on page size or termination of pagination leave gaps given 0% schema description coverage.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must carry parameter meaning, and it only partially does. It clarifies the purpose of 'offset' (paging into older modules), but the required 'programId' UUID is never mentioned, leaving the caller unaware that results are scoped to a single program.

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 ('Read module records') plus a meaningful scope detail ('in teaching order'), which an agent can act on. It implicitly separates itself from the write-side sibling record_module via 'before saving', but never names an alternative explicitly, so it falls short of a 5.

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 real usage context: paginate with offset to inspect older modules, or read to verify a module number before saving (i.e., before calling record_module). There is no explicit 'when not to use' or named alternative, so it is clear context rather than full routing guidance.

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.

Resources