Skip to main content
Glama

List the documents the user can reach

tools_list_documents
Read-only

Return the tool documents the signed-in user owns or shares through a Space, most recently edited first, with each one's id, tool, version, role, Space, and url (the page that opens it in its builder). Pass toolKey to list one builder's documents. Every other document tool needs one of these ids.

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": "tools_list_documents"
  }
}

Input Schema

NameRequiredDescriptionDefault
toolKeyNoWhich builder: ost | usm | cfd | vsm | noice | wardley | roi | roadmap.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so safety is covered structurally. The description still adds useful behavior: the access scope (owned or Space-shared only), the sort order, and the per-item fields including the builder URL. It does not discuss result limits, pagination, or what happens with very large collections.

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?

Four short sentences, front-loaded with the core action and scope, then ordering, then return shape, then the parameter rule and the dependency on ids. No filler or repetition of the title.

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 output schema, the description compensates by enumerating the fields each returned document contains, and it explains the id dependency for other tools. It leaves pagination/result-cap behavior unspecified, which is the main remaining gap for a list tool.

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?

Schema coverage is 100% and the single enum parameter is already documented, so the baseline is 3. The description goes slightly beyond by explaining the semantic effect of toolKey — it narrows the list to one builder's documents — rather than just restating the enum values.

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?

States a specific verb and resource plus scope: documents the signed-in user owns or shares through a Space, ordered most-recently-edited first. It also enumerates the returned fields (id, tool, version, role, Space, url), which separates it clearly from tools_get_document and the per-builder *_apply_commands siblings.

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?

Gives a concrete selection rule for the optional parameter ('Pass toolKey to list one builder's documents') and a strong downstream cue ('Every other document tool needs one of these ids'), which tells the agent this is the entry point for id discovery. It stops short of naming alternative listing tools such as list_by_tag or list_by_category, so no explicit exclusions are stated.

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