Skip to main content
Glama

Describe Module

describe_module
Read-only

Inspect one builtin module type: pass type with optional config. Omitted/null config inspects type defaults; supplied config uses creation's validation/defaults. Config limit: 16 KiB; response payload: 64 KiB. Errors are explicit.

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

Input Schema

NameRequiredDescriptionDefault
typeNoRegistered type name. Omit when selecting a running module_id.
configNoType-specific config with creation's defaults/validation. Omit or null for defaults. Not accepted with module_id. Maximum serialized size: 16 KiB.
module_idNoExisting running instance ID; reads actual ports and controls without rebuilding.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior4/5

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

Beyond the readOnlyHint annotation, the description discloses real operational traits: a 16 KiB config ceiling, a 64 KiB response payload budget, and that errors are surfaced explicitly rather than silently defaulted. These are exactly the kind of limits an agent needs before composing a large config, though 'Errors are explicit' is asserted without saying what an error looks like.

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?

Roughly four tight sentences with the primary action front-loaded and constraints grouped at the end; nothing is padded. It is telegraphic to the point that 'Errors are explicit' borders on filler, but overall density is high and well ordered.

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?

With three optional parameters, no output schema, and only a readOnlyHint annotation, the description covers invocation modes and resource limits well. The notable gap is return shape: it budgets the response at 64 KiB but never says what a module description contains, which is the one thing an agent cannot learn from structured fields here.

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 coverage is 100%, so the baseline is 3. The description reinforces the type/config relationship and restates the 16 KiB config limit and the omitted-vs-supplied config semantics that the schema already documents, adding framing but no new syntax or format details, and it says nothing about the third parameter module_id.

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 opens with a specific verb and scope: 'Inspect one builtin module type,' which distinguishes a single-type introspection from the sibling list-style tool describe_module_types. It states the core invocation shape (pass type with optional config) but never names a sibling explicitly, so the differentiation is implicit rather than stated.

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?

It gives conditional guidance for the config argument (omit/null for type defaults, supply to get creation-time validation/defaults), which is genuinely useful for choosing an invocation mode. However, it offers no when-to-use versus alternatives guidance — nothing tells the agent to call describe_module_types first to discover a valid type, and the module_id selection path is left entirely to the schema.

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