Skip to main content
Glama

Read modules

modules_read
Read-onlyIdempotent

Lists installed and available modules of the active site; shows module status and the indexing quarantine status.

Input Schema

NameRequiredDescriptionDefault
actionYesOperation to run. Each oneOf entry describes one action and lists its parameters.
offsetNoRecords to skip from the start of a list; overrides page. A list reply cut at its size limit names the offset that follows in next.
module_codeNoLowercase module code, as listed by modules_list (field module) or active_mods (field code) on the active site.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / action / oneOf
      Previous value: -[
      -  {
      -    "const": "active_mods",
      -    "description": "Lists the modules installed on the site."
      -  },
      -  {
      -    "const": "modules_list",
      -    "description": "Lists all modules with their installed and uAPI flags (needs Control Panel access)."
      -  },
      -  {
      -    "const": "module_status",
      -    "description": "Returns the status of one module (needs Control Panel access). Required: module_code."
      -  },
      -  {
      -    "const": "quarantine_status",
      -    "description": "Returns the indexing quarantine status of the site."
      -  }
      -]New value: +[
      +  {
      +    "const": "active_mods",
      +    "description": "Lists the modules installed on the site. Optional: offset."
      +  },
      +  {
      +    "const": "modules_list",
      +    "description": "Lists all modules with their installed and uAPI flags (needs Control Panel access). Optional: offset."
      +  },
      +  {
      +    "const": "module_status",
      +    "description": "Returns the status of one module (needs Control Panel access). Required: module_code."
      +  },
      +  {
      +    "const": "quarantine_status",
      +    "description": "Returns the indexing quarantine status of the site."
      +  }
      +]
    • addedInput schema / properties / offset
      Added value: +{
      +  "description": "Records to skip from the start of a list; overrides page. A list reply cut at its size limit names the offset that follows in next.",
      +  "type": "number"
      +}
  2. Added

TDQS

B3.2/5.0
Behavior3/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. The description contributes the useful scoping detail that it operates on the 'active site' and mentions the quarantine-status dimension, but says nothing about pagination limits or result shape beyond that.

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 compact sentence, front-loaded with the primary purpose and scoped to the active site. The second clause slightly overlaps with the first ('installed and available modules' vs 'module status'), but there is no padding.

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 take on some burden of describing returns, and it does so at a high level (module status, quarantine status) while the schema handles all parameters. Combined with the read-only annotations, an agent has enough to call this correctly, though return fields and pagination behavior are only inferable from the schema.

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%: every action variant, the offset semantics, and the module_code format are fully documented in the schema. The description adds no parameter detail beyond the schema, so the baseline 3 applies.

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?

Names a specific verb and resource (lists modules of the active site) and even enumerates the kinds of information returned (module status, indexing quarantine status), so the agent knows exactly what this tool surfaces. It does not explicitly differentiate itself from modules_write/modules_uninstall, but the read/list framing makes the boundary reasonably clear.

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

Usage Guidelines2/5

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

The description offers no when-to-use guidance, no prerequisites, and never names an alternative such as modules_write or modules_uninstall. The action enum lives entirely in the schema, so the description itself gives the agent nothing to route on.

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.