Skip to main content
Glama
nic01asFr
by nic01asFr

list_documents

Retrieve all documents in a specified Grist workspace by providing a workspace ID. Use this to list document IDs before exploring tables or modifying documents.

Instructions

Liste tous les documents dans un espace de travail Grist.

Prérequis: - list_workspaces: Pour obtenir un workspace_id valide

Flux de travail typique: 1. list_workspaces(org_id) → obtenir workspace_id 2. list_documents(workspace_id) → obtenir doc_id 3. list_tables(doc_id) → explorer les tables du document

Voir aussi: - create_document: Pour créer un nouveau document - describe_document: Pour obtenir les détails d'un document - modify_document_access: Pour gérer les permissions

Args: workspace_id: L'ID de l'espace de travail

Returns: Dict avec: - success (bool): Indique si l'opération a réussi - message (str): Message de succès ou d'erreur - documents (List): Liste des documents

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
workspace_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior4/5

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

No annotations provided, but description discloses the return structure (success, message, documents) and parameter requirement. It does not mention side effects or permissions, but as a read-only list operation, this is adequate.

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?

The description is well-structured with clear sections (prerequisites, workflow, see also, args, returns) and is concise without superfluous information.

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

Completeness5/5

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

Given the tool's low complexity, one parameter, and an output schema that documents return values, the description is fully complete. It covers all necessary aspects for correct usage.

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 0%, but the description adds a brief explanation for the only parameter: 'workspace_id: L'ID de l'espace de travail'. This adds meaning beyond the schema's type definition.

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?

The description clearly states it lists all documents in a Grist workspace, using a specific verb ('Liste') and resource ('documents'). It distinguishes from siblings like create_document, describe_document, and modify_document_access.

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

Usage Guidelines5/5

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

Provides explicit prerequisites (list_workspaces), a typical workflow, and references to related tools under 'Voir aussi'. It gives clear context on when to use this tool.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/nic01asFr/mcp-server-grist'

If you have feedback or need assistance with the MCP directory API, please join our Discord server