Skip to main content
Glama

get_project_map

Get the repo structure from PROJECT_MAP.md: file layout, entry points, and ownership—no filesystem scanning needed.

Instructions

Read PROJECT_MAP.md to understand the repo structure.

Call this at session start when structure matters (file layout,
entry points, ownership). Cheaper than scanning the filesystem.

Read-only. Returns 'No project map found.' if PROJECT_MAP.md hasn't
been initialized — run `pjm init` first if so.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
projectNoWhich project this call is about — a registered id, alias, or absolute path (e.g. 'ossdrop'). Omit it when the server was started for a single repo, or when an active project is set with `pjm project use`. Call list_projects to see the registered names.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.3.2
    • addedInput schema / properties / project
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Which project this call is about — a registered id, alias, or absolute path (e.g. 'ossdrop'). Omit it when the server was started for a single repo, or when an active project is set with `pjm project use`. Call list_projects to see the registered names.",
      +  "title": "Project"
      +}
  2. First observedv0.1.1

TDQS

A4.5/5.0
Behavior5/5

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

With no annotations supplied, the description carries the full burden and does well: it declares 'Read-only,' specifies the exact return message when PROJECT_MAP.md is missing, and notes the prerequisite to run `pjm init` first. It also adds a performance trait ('Cheaper than scanning the filesystem').

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?

Three concise sentences, each with a distinct purpose: what it does, when to use it, and its read-only/missing-file behavior. No filler.

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

Completeness5/5

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

For a single-optional-parameter read tool with a full output schema, the description covers the important operational details: when to call it, read-only nature, missing-file behavior, and initialization prerequisite. The parameter semantics live in the schema, so nothing essential is missing.

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 input schema already documents the optional project parameter in depth (registered id, alias, path, omit conditions, and a pointer to list_projects), and coverage is 100%. The description adds no parameter-specific guidance, so baseline 3 applies.

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 opens with a specific verb and resource ('Read PROJECT_MAP.md') and explains its purpose ('understand the repo structure'). It further distinguishes this tool from filesystem traversal by noting it is 'Cheaper than scanning the filesystem,' and its unique focus on file layout, entry points, and ownership separates it from sibling tools like get_summary or get_context.

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 explicit timing ('Call this at session start') and conditions ('when structure matters'), and names an alternative approach (filesystem scanning) with a cost comparison. It does not explicitly list when-not-to-use cases, but the conditional 'when structure matters' implies the boundary, so clear context but no formal exclusions.

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