Skip to main content
Glama
Grist MCP Server
by nic01asFr

Modify Document

modify_document

Update a Grist document's name or pinned status using its document ID.

Instructions

Modifie les propriétés d'un document.

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

Input Schema

NameRequiredDescriptionDefault
nameNoNouveau nom pour le document (optionnel)
doc_idYesL'ID du document à modifier
is_pinnedNoÉtat d'épinglage du document (optionnel)

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv0.2.2
    • addedInput schema / properties / doc_id / description
      Added value: +"L'ID du document à modifier"
    • addedInput schema / properties / is_pinned / description
      Added value: +"État d'épinglage du document (optionnel)"
    • addedInput schema / properties / name / description
      Added value: +"Nouveau nom pour le document (optionnel)"
  2. First observedv0.1.0

TDQS

C2.5/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 for a mutation tool, and it adds essentially nothing: it does not say whether the update is partial or full, what happens when the optional fields are null, what permissions are required, or whether existing values are overwritten. Only the bare fact that something is modified is conveyed.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

It is a single sentence with no padding, so nothing is wasted, but this brevity comes at the cost of under-specification rather than from disciplined editing. There is no structure that would help the reader understand the tool's scope.

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

Completeness2/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 described. But for a mutation tool with three parameters, one required and no annotations, the definition should cover which properties can be changed and how overlaps or omitted fields behave; the one-sentence description leaves those questions unanswered.

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%, so the schema already explains doc_id, name, and is_pinned in more detail than the description does. The description's phrase "propriétés" adds no semantics beyond that baseline, so the score is the expected baseline of 3.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

"Modifie les propriétés d'un document" states a verb and a resource, so the general intent is clear. But "propriétés" is vague: it does not name the updatable fields (name, is_pinned) that the schema exposes, and it gives no signal that distinguishes this tool from siblings such as modify_document_access or move_document.

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 when-to-use guidance, no exclusions, and no mention of the sibling tools that also act on a document. The agent must infer from the name alone that this is for renaming or pinning a document rather than changing its access or location.

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