Skip to main content
Glama

Read module settings

settings_read
Read-onlyIdempotent

Reads module settings of the active site: lists the modules that have settings and whether each one is active, and returns the current settings of a module. Does not change anything.

Input Schema

NameRequiredDescriptionDefault
actionYesOperation to run. Each oneOf entry describes one action and lists its parameters.
moduleNoModule code. site holds the general site settings.
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.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / action / oneOf
      Previous value: -[
      -  {
      -    "const": "settings_modules",
      -    "description": "Lists the modules whose settings can be read and changed, and whether each one is active on the site (null when not tracked)."
      -  },
      -  {
      -    "const": "settings_get",
      -    "description": "Returns the current settings of a module (nested). Access keys are shown only as (set) or empty. Required: module."
      -  }
      -]New value: +[
      +  {
      +    "const": "settings_modules",
      +    "description": "Lists the modules whose settings can be read and changed, and whether each one is active on the site (null when not tracked). Optional: offset."
      +  },
      +  {
      +    "const": "settings_get",
      +    "description": "Returns the current settings of a module (nested). Access keys are shown only as (set) or empty. Required: module."
      +  }
      +]
    • 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

A3.7/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, idempotentHint=true and a closed world, so the safety profile is fully covered and 'Does not change anything' is largely redundant. The description adds a little context by scoping reads to the active site, but says nothing about permissions or how access-key redaction is returned beyond what the schema already notes.

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 with the purpose and the two sub-behaviors front-loaded, followed immediately by the read-only reassurance. Efficient, though the semicolon clause packs two actions into one long sentence that could be split for faster scanning.

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 carries the return-value burden and does so adequately: it states that the list includes which modules have settings and whether each is active, and that a module's settings come back nested. Minor gaps remain on permissions and truncation behavior, but the schema covers truncation via offset/next.

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 oneOf action entries, the module enum and the offset/next semantics are already fully documented in the schema. The description contributes no additional parameter meaning such as mutual exclusivity rules or defaults, so the baseline 3 applies.

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?

States a specific verb and resource ('Reads module settings of the active site') and enumerates the two concrete behaviors: listing modules with active status, and returning a module's current settings. The scope is narrowed to the active site, so an agent can distinguish it from the sibling settings_write and from app/forum-specific readers without opening a schema.

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 only implied: the closing 'Does not change anything' signals read-only intent, which points an agent away from settings_write, but there is no explicit when-to-use statement, no conditions, and no named alternatives (e.g. modules_read vs settings_read). The agent must infer the routing.

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.