Skip to main content
Glama
Grist MCP Server
by nic01asFr

Describe Document

describe_document

Retrieves detailed information about a specific Grist document using its document ID, helping you inspect document metadata and settings before managing tables or records.

Instructions

Obtient des informations détaillées sur un document spécifique.

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": {
      "doc_id": "<doc_id>"
    },
    "name": "describe_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
doc_idYesL'ID du document à décrire

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.2.2
    • addedInput schema / properties / doc_id / description
      Added value: +"L'ID du document à décrire"
  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 provided, so the description carries the full behavioral burden and discloses almost nothing: it does not say the operation is read-only, what class of 'detailed information' is returned, whether permissions are required, or whether the call has any side effects. Only the existence of an output schema offsets this partially.

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 wasted wording. Its brevity is efficient rather than padded, though the terseness is also what leaves the guidance gaps.

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?

With an output schema present, return values need not be explained, and the single parameter is fully documented in the schema. However, with zero annotations, a reader still cannot tell whether this is a safe read-only call or what 'detailed information' covers, which is a meaningful gap for a description this short.

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?

There is one parameter (doc_id) with 100% schema description coverage, so the schema already defines it ('L'ID du document à décrire'). The description adds no format, sourcing, or validity information beyond that, which is the baseline case for high schema coverage.

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 ('Obtient des informations détaillées sur un document spécifique'), which is clearly distinct from mutating siblings like modify_document or delete_document. It stops short of naming or contrasting any sibling explicitly (e.g. describe_workspace, list_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 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 versus alternatives such as list_document_access or the other describe_* tools. Usage is only implied by the verb 'describe'; no prerequisites, exclusions, or routing hints are given.

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