Skip to main content
Glama
Grist MCP Server
by nic01asFr

List Documents

list_documents

Retrieve all documents in a specified Grist workspace by providing its workspace ID, so you can view and manage available documents.

Instructions

Liste tous les documents dans un espace de travail Grist.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "workspace_id": "<workspace_id>"
    },
    "name": "list_documents"
  }
}

Input Schema

NameRequiredDescriptionDefault
workspace_idYesL'ID de l'espace de travail

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.2.2
    • addedInput schema / properties / workspace_id / description
      Added value: +"L'ID de l'espace de travail"
  2. First observedv0.1.0

TDQS

C2.9/5.0
Behavior2/5

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

No annotations are supplied, so the description carries the full behavioral burden, yet it says nothing about pagination, result limits, permission requirements, or ordering of the returned document list. For a read tool over a potentially large collection, these are meaningful omissions.

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 filler or redundancy. It is efficient, though its brevity is partly the source of the missing guidance rather than a virtue in itself.

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 the tool has only one simple required parameter. However, with no annotations and no mention of pagination or permissions, the description is only minimally complete for a collection-listing tool.

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 description coverage is 100% with a single required integer workspace_id already documented in the schema, so the baseline is 3. The description adds no format hints or constraints (e.g., where to obtain the ID) beyond what the schema states.

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 states a specific verb and resource ("Liste tous les documents") and scopes it to a Grist workspace, so the agent knows exactly what the tool returns at a high level. It does not differentiate itself from nearby siblings such as describe_document or list_workspaces, so it stops short of 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 Guidelines2/5

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

There is no guidance on when to use this tool rather than describe_document, list_records, or list_workspaces, and no prerequisites or exclusions are mentioned. The workspace scoping is implied by the schema's required workspace_id but never framed as a usage condition.

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