Skip to main content
Glama

Show the project map

get_project_map
Read-onlyIdempotent

Call this first in a session: a compact plain-text map of the project, naming the sibling services this project indexes, the contracts this repo depends on, who consumes this repo, and the unmatched calls with how many of them match no route, with the drill-down tool at the end of every section. Cheap; pass service to split THIS REPO from its siblings, detail for more rows per section.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
repoNoYour repo as owner/repo (git remote) or just the repo name. Resolves which Carrick project to query.
detailNoRaise the per-section row caps roughly fivefold. Use it when the default map collapsed a section you need to read.
projectNoCarrick project slug to query. Omit to auto-resolve via `repo`, or omit both when the workspace has one project.
serviceNoYour repo or service, so the map splits THIS REPO from the siblings you do not have checked out (fuzzy match by service name, repo name, or trailing segment). Omit on a single-service project; omit on a multi-service one to render the whole project.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive/closed-world, so the safety profile is covered. The description adds real value beyond that: output is compact plain-text, it is cheap, every section ends with a drill-down tool, and it is meant to be the first call in a session.

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 highest-value instruction ('Call this first in a session') and every clause carries information about output content or parameter use. It is a single dense run-on sentence, which makes it slightly harder to scan than it needs to be.

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?

No output schema exists, so the description carries the burden of describing returns — and it does, listing the four section types and the drill-down affordance. It stops short of naming those drill-down tools or noting size/pagination behavior, but is otherwise sufficient for a zero-required-param, read-only tool.

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%, so the schema already explains repo, project, detail, and service with the same 'when to use it' framing. The description restates the service split and detail row caps without adding syntax, defaults, or format detail the schema lacks, so the 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?

States a specific verb+resource ('map of the project') and enumerates exactly what the map contains: sibling services, contracts depended on, consumers, unmatched calls. This distinguishes it from siblings like get_service_graph and get_service_dependencies, which cover overlapping-but-different slices.

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 a clear entry-point rule ('Call this first in a session') and conditions for the two optional params (split THIS REPO from siblings; more rows when a section collapsed). It does not name the alternative tools an agent might use instead, so it falls short of full when/when-not/alternatives coverage.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.