Skip to main content
Glama

module_summary

Read-onlyIdempotent

Summarize a file's module by listing defined symbols, imports, and dependent files from the call graph. Read before editing unfamiliar code to understand its impact.

Instructions

A file as a unit: the symbols it defines, what it imports, and which files depend on it (via the call graph). Read it before editing a file you don't know.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
fileYesFile path or fragment, e.g. `VoxelWorld.cs`.
limitNoMax symbols to list.
sourceNoSource name. Omit when only one source applies.

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. Addedv1.9.0

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and non-destructive behavior. The description adds behavioral context beyond that: the tool summarizes a file's defined symbols, imports, and dependents as computed via the call graph. This clarifies what the agent should expect without repeating annotation data.

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

Conciseness5/5

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

Two sentences, no filler. The definition is front-loaded and the usage guidance is actionable. Every word contributes to either clarifying the tool's output or telling the agent when to invoke it.

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?

For a read-only summary tool with fully documented parameters and safety annotations, the description provides sufficient context. It states what the output covers (symbols, imports, dependents) even without an output schema, though it could more explicitly mention how the optional 'source' parameter affects results.

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?

The schema covers all parameters with descriptions at 100% coverage, so the baseline is 3. The tool description does not add parameter-level details, but it does contextualize the primary 'file' parameter by describing the file-as-a-unit scope. No additional compensation is needed.

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 defines a clear scope: one file as a unit, covering the symbols it defines, imports, and dependent files via the call graph. It also supplies a direct action ('Read it before editing a file you don't know'), which makes the purpose unmistakable and distinguishes it from symbol-level tools like describe_symbol and impact.

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?

The description gives an explicit use case: read this before editing an unfamiliar file. It does not explicitly enumerate when not to use it or name alternative tools, but the context is clear enough for an agent to decide when module_summary is the right starting point.

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

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/lorenzo-cambiaghi/LynxMCP'

If you have feedback or need assistance with the MCP directory API, please join our Discord server