Skip to main content
Glama

get_module_info

Retrieve a module’s registration and metadata—version, description, author, service contract, and recent error details—to inspect or troubleshoot a specific bot module.

Instructions

查询指定模块的注册信息与元信息(版本/描述/作者/服务契约/最近错误现场)。

Args: name: 模块名(先用 list_modules 获取候选)

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "name": "<name>"
    },
    "name": "get_module_info"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYes

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.1/5.0
Behavior3/5

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

There are no annotations to fall back on, so the description carries the full burden. It discloses part of the behavior by enumerating what metadata is returned, but it never states that the operation is read-only, never says how not-found or unregistered module names behave, and never describes how errors are surfaced.

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?

It is a compact two-part structure that opens with the purpose and then documents the argument. The parenthetical field list is slightly redundant with the existing output schema, which is what keeps it just short of ideal.

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?

An output schema exists, so return values need not be spelled out, and with a single parameter the description is nearly sufficient to invoke the tool. The gap is behavioral: with zero annotations, it should say this is a read-only lookup and how invalid names fail.

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

Parameters4/5

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

Schema coverage is 0%, so the description must supply meaning for name, and it does: it is the module name and must be obtained from list_modules. With only one required parameter, this is enough meaning to call the tool correctly, though no naming or format examples are given.

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 a specific verb+resource: retrieving a single named module's registration and metadata (version/description/author/service contract/most recent error scene). That scope distinguishes it from the sibling list_modules, which is explicitly positioned as the discovery step rather than the retrieval step.

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 a concrete prerequisite workflow: call list_modules first to obtain candidate module names, then pass one to this tool. It does not state when not to use it, and does not discuss alternatives such as call_module or get_adapter_status, so it falls short of full routing guidance.

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