Skip to main content
Glama

list_project_documents

Read-only

Lists project documents by category—guidance, specifications, archive, or all—with pagination, so you can locate the document to read next.

Instructions

Explicit paginated inventory: project guidance (default), baseline specifications, archive, or all. Fetch exact text with read_project_document.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "list_project_documents"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNo
cursorNo
categoryNoproject
workspacePathNoTrusted absolute project path from this chat; pass on every call. null selects personal storage. Omission uses only the environment default.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.5.1

TDQS

A3.7/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered externally. The description adds that results are paginated and that category defaults to project, but says nothing about page size behavior, how cursors expire or compose, or ordering of results.

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 tight sentences with zero filler: the scope and default come first, and the hand-off to read_project_document comes second. Nothing is repeated from the name or the schema.

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

Completeness3/5

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

There is no output schema, so the description carries the burden of describing what a listing entry looks like and how pagination resumes; it only says "paginated" without explaining the cursor/next-page contract. For a 4-parameter enumeration tool this is serviceable but leaves the return shape and workspacePath handling unexplained.

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 coverage is only 25%, with only workspacePath described in the schema; the description compensates for exactly one gap by spelling out the category values and the default. It says nothing about limit bounds, cursor opacity/expiry, or the critical workspacePath rule that it must be passed on every call, so compensation is partial.

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?

"Explicit paginated inventory" plus the enumerated categories makes it clear this returns a list of project documents rather than their contents, and it names the sibling (read_project_document) that returns text. The wording "inventory" and "project guidance/baseline specifications" is slightly softer than the enum names (project/specification), so an agent must map terms, keeping it just below a 5.

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 explicitly routes content retrieval to read_project_document, which is the key use/use-instead distinction against the most confusable sibling, and it states the default category (project). It gives no guidance on when to pick archive or all versus the narrow defaults, and no prerequisites are stated.

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