Skip to main content
Glama

List Project Documents

list_project_documents
Read-onlyIdempotent

Paginate the documents accessible in a project.

Input Schema

NameRequiredDescriptionDefault
idYes
limitNo
offsetNo

Output Schema

NameRequiredDescriptionDefault
nodeYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, closed-world and non-destructive, so the safety profile is covered. The description adds that results are paginated and filtered to what is 'accessible' in a project, which implies permission-scoped visibility, but it does not state ordering, page-size defaults, or total-count behavior.

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?

A single front-loaded sentence with no waste. Its brevity is efficient, though it shades into under-specification given the undocumented parameters.

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?

An output schema exists so return values need not be explained, and annotations cover safety. The remaining gap is the ambiguity of the required 'id' parameter and the pagination contract, neither of which is addressed.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% across three parameters, so the description must carry this burden and it does not. Nothing says that 'id' is a project identifier rather than a document ID, and no pagination mechanics (limit default 20, max 50, offset) are conveyed beyond the generic word 'paginate'.

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?

States a specific verb+resource and adds the scoping qualifier 'accessible in a project', which separates it from the general list_documents sibling. It does not name that sibling explicitly, so the differentiation is implicit rather than stated.

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

Usage Guidelines2/5

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

Gives no guidance on when to use this versus list_documents, search, or get_project. The agent must infer that this is the project-scoped variant purely from the name.

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.

Resources