Skip to main content
Glama

get_project_docs_overview

List all project documentation files with sizes and classification labels to identify available internal and public docs before reading.

Instructions

List all documentation files for the current project with file sizes and classification labels.

Call this tool first when the user asks what docs exist, wants a summary of project documentation, or before deciding which files to read. It is read-only and has no side effects.

Scans two locations: the alcove doc-repo (private/internal docs) and the project repository root + docs/ (public-facing docs).

Classification labels:

  • doc-repo-required: core internal docs required by policy (e.g. PRD, ARCHITECTURE)

  • doc-repo-supplementary: optional internal extras

  • project-repo: public-facing docs in the project repo (e.g. README, CHANGELOG)

  • reference: reports and reference materials

  • unrecognized: files not matching any known category

Returns an empty list if no docs exist yet. Use init_project to create initial docs.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior5/5

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

No annotations provided, so description carries full burden. It fully discloses behavior: scans two locations, classification labels, empty list return, and read-only nature. No contradictions.

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?

Well-structured and concise: first sentence states purpose, then usage advice, then details about locations and classifications. Front-loaded with key information; no wasted words.

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?

Covers all needed information: purpose, when to use, where it scans, classification labels, edge case (empty list), and reference to related tool. No missing details given lack of output schema.

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?

There are no parameters, so schema coverage is 100%. Baseline for 0 params is 4. The description adds no parameter info, which is appropriate.

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?

Clearly states it lists documentation files with sizes and classification labels. The verb 'List' and resource 'documentation files for the current project' are precise, and the description distinguishes from siblings like get_doc_file and init_project.

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?

Explicitly advises to call this tool first when the user asks about docs or wants a summary. It notes it is read-only with no side effects. While it does not explicitly list when not to use it, it provides clear guidance.

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

Install Server

Other Tools

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/epicsagas/alcove'

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