Skip to main content
Glama

project_map

Inspect every module and definition in a Renyi codebase with signatures, purposes, effects, failures, edges, metrics, and content hashes; filter by module or request JSON.

Instructions

The project map of the served directory: one record per module and per definition with signature, purpose, effects, failures, edges, metrics and content hash. module narrows it to one module; json gives the JSON shape of renyi index --json instead of the one-line-per-definition text.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
jsonNotrue for the JSON shape; the text form by default
moduleNoa module name, to show only that module

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.1

TDQS

A3.5/5.0
Behavior3/5

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

Annotations are absent, so the description carries the full behavioral burden. It discloses the output structure (one record per module/definition, fields, text vs JSON) but says nothing about read-only safety, side effects, authentication, performance, or rate limits. For a query tool this is adequate but incomplete.

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, front-loaded with the output contract then parameter behavior. No filler; every clause carries information and the structure is efficient.

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 no output schema, the description must explain returns, and it does list the record contents and format options. It lacks details on nested field shapes, but for a 2-parameter read-only map tool the coverage is sufficient.

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 100% and both parameters are documented. The description adds useful context: json yields the JSON shape of `renyi index --json` versus the default one-line-per-definition text, and module narrows to one module. This goes beyond the schema's terse descriptions.

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 names the artifact ('project map of the served directory') and enumerates the per-definition fields it returns (signature, purpose, effects, failures, edges, metrics, content hash), giving a specific scope. It does not explicitly contrast with siblings like definition or effects, but the breadth of records distinguishes it as the whole-project map.

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?

No when-to-use guidance or alternatives are offered. The second sentence only explains parameter effects (module narrowing, json shape), not when to choose this tool over definition, effects, or chunks.

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