Skip to main content
Glama

Project map

map
Read-onlyIdempotent

Get an overview of an unfamiliar repository: summarize files, languages, modules and quality, or inspect layers, dependencies, entry points and hub symbols before opening files.

Instructions

Get an overview of the project: "give me an overview", "how is this structured", "where do I start", "what are the main modules". 'summary' lists files, languages, top modules and quality. 'architecture' gives layers, module dependencies, entry points and the most connected symbols. 'full' gives both. Use it at the start of work in an unfamiliar repository, before you list directories or open files one by one.

Input Schema

NameRequiredDescriptionDefault
detailNo'summary' (files/languages/quality/top-modules), 'architecture' (layers/dependencies/classes/entry points/hub symbols), or 'full' (both)summary

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.1.0
    • addedInput schema / properties / detail / enum
      Added value: +[
      +  "summary",
      +  "architecture",
      +  "full"
      +]
  2. First observedv1.0.4

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so the safety profile is fully covered structurally. The description adds what each mode surfaces (files/languages/quality vs layers/dependencies/entry points), but says nothing about output size, cost, or whether 'full' is expensive on large repositories — the main behavioral risk for an overview tool.

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?

Front-loaded with the core purpose, then intent examples, then mode semantics, then usage timing — a sensible order with little waste. There is mild redundancy between the description's mode list and the enum's own descriptions, but nothing is padded.

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 an output schema present, the description need not explain return values, and the single optional parameter is fully covered; annotations cover safety. The only meaningful gap is guidance on when the richer 'architecture'/'full' modes are worth the extra output versus defaulting to 'summary'.

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% and the single enum is already documented in the schema; the description's mode explanations largely restate that text ('full' gives both appears in both places). Baseline 3 applies since the schema does the work and the description adds only minor rephrasing.

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?

States a specific verb and resource ('Get an overview of the project') and reinforces it with real user phrasings ('how is this structured', 'where do I start') plus a breakdown of the three detail modes. It does not explicitly name or contrast the siblings (search, find_symbol, graph, status), so an agent must infer that this is the orientation tool rather than a lookup tool.

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?

Gives clear timing guidance: 'Use it at the start of work in an unfamiliar repository, before you list directories or open files one by one.' That establishes when to use it and steers away from manual exploration, but it names no alternative sibling (e.g. status or index) and gives no when-not condition, such as skipping it in a repo you already know.

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

Deploy Server

Other Tools