Skip to main content
Glama

list-documents

Lists all indexed documents available for study and returns their names for the document parameter in ask-document and generate-quiz.

Instructions

Lists all documents that have been indexed and are available for study. Returns the document names to use in the 'document' parameter of ask-document and generate-quiz.

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-documents"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A3.9/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the full burden. It does disclose the underlying behavior (documents must be indexed to appear) and what is returned, but it says nothing about ordering, whether metadata accompanies names, or behavior on an empty index. For a simple read-only listing tool this is adequate rather than rich.

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 sentences, front-loaded with the action and followed by the downstream use. Every clause earns its place and there is no redundant restatement of the tool name.

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?

With no input parameters and no output schema, the description covers the essential ground: what is listed and what the caller receives (document names). Only minor gaps remain around result ordering and empty cases, which are unlikely to block a correct call.

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?

The tool takes zero parameters, so there is nothing for the description to disambiguate and the baseline expectation is satisfied. It usefully notes the sibling 'document' parameter the output feeds, which is the only parameter semantics relevant here.

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?

The description opens with a specific verb and resource ('Lists all documents') and adds a scope qualifier ('indexed and are available for study'), so an agent knows exactly what set is returned. It stops short of explicitly contrasting with the nearby extract-document-index, but the 'indexed/available' framing does most of that work implicitly.

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 tells the agent why and when to call it: the returned names are the values to pass into the 'document' parameter of ask-document and generate-quiz, which effectively positions this as the prerequisite discovery step. There is no explicit when-not guidance, but with a zero-parameter listing tool that is a minor omission.

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