Skip to main content
Glama

module_info

Read-only

Retrieve a PCB module's card, ports, parts, sources and origin by name so an AI agent can inspect a board's building blocks before design changes.

Instructions

A module's card, ports, parts, sources and origin.

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

Input Schema

NameRequiredDescriptionDefault
nameYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds value by listing the categories of information returned in the absence of an output schema, but says nothing about failure behavior when a module name is unknown or about size/shape of the response.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

It is extremely short and front-loads the field list, so there is no wasted wording. However, it is a noun-phrase fragment rather than a sentence with an action, which weakens readability and structure.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a lookup tool with no output schema, the description does list return categories but omits the required parameter's meaning and any behavioral detail such as not-found handling. It is thin relative to what an agent needs to invoke it confidently.

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% for the single required parameter, and the description never mentions "name" or clarifies that it is a module identifier rather than a part or circuit name. With no compensation in the description, the agent must guess the expected value format.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description enumerates what the tool surfaces (a module's card, ports, parts, sources and origin), which identifies the resource but never states a verb or action such as "retrieve" or "get". The use of "module's" implicitly separates it from the sibling part_info, but an agent must infer the operation from the tool name.

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?

There is no guidance on when to call this versus sibling helpers like part_info, board_summary or circuit_summary, nor any prerequisite or exclusion. The agent is left to infer that this is the lookup for a named module's metadata.

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