Skip to main content
Glama

project_snapshot

Read-only

Fetch a bounded coding project overview in one call: Git status, top-level tree, package scripts, project hints, and agent instructions. Understand any project's setup quickly.

Instructions

Read a bounded coding-oriented project snapshot in one call: Git status, top-level tree, package/scripts, project type hints, common agent instruction files, and Pilot GPT.md context provenance.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathNoProject directory; defaults to the workspace root.
includeNoSections to include; defaults to all.
max_tree_entriesNoMaximum top-level entries; defaults to 100.

Schema Changelog

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

  1. Addedv1.2.1

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already establish read-only and non-destructive behavior. The description adds useful behavioral context by defining the snapshot as 'bounded' and by specifying exactly which data sources are read. This aligns with readOnlyHint=true and gives the agent a clear picture of the tool's scope without contradicting annotations.

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?

The description is a single well-constructed sentence that front-loads the action and scope, then efficiently lists the snapshot components. Every clause adds information; there is no filler or redundant restating of the tool name.

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 an optional-parameter read-only tool with no output schema, the description sufficiently explains what the tool returns by naming each snapshot section. Together with the fully documented input schema and safety annotations, the agent has everything needed to invoke it correctly.

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%, with each parameter already documented with defaults and types. The description adds general context about snapshot content but does not materially deepen the meaning of path, include, or max_tree_entries beyond what the schema provides, so the baseline score of 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 uses a specific verb ('Read') with a specific resource ('bounded coding-oriented project snapshot') and enumerates the concrete contents included: Git status, top-level tree, package/scripts, project type hints, instruction files, and Pilot GPT.md provenance. This clearly distinguishes it from granular sibling tools like git_status, read_files, or list_directory.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The phrase 'in one call' implies the tool is meant for efficient project-wide orientation, and the enumerated sections suggest when it is useful. However, it does not explicitly name alternatives or state when to prefer a granular sibling like git_status or read_files instead, leaving usage boundaries to inference.

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/JonusNattapong/chatgpt-pilot'

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