Skip to main content
Glama
Grist MCP Server
by nic01asFr

Export Schema

export_schema

Exports the schema of an existing Grist document as JSON, YAML, or Mermaid, optionally including up to 100 records per table for documentation or analysis.

Instructions

Exporte le schéma d'un document existant.

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

Input Schema

NameRequiredDescriptionDefault
doc_idYesL'ID du document
formatNoFormat d'export ("json", "yaml", "mermaid")json
include_dataNoSi True, inclut les données (limité à 100 enregistrements/table)

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"
    • addedInput schema / properties / format / description
      Added value: +"Format d'export (\"json\", \"yaml\", \"mermaid\")"
    • addedInput schema / properties / include_data / description
      Added value: +"Si True, inclut les données (limité à 100 enregistrements/table)"
  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 burden and does almost nothing with it. It does not state that the operation is read-only and non-destructive, whether export honors permissions, or how the 100-record cap on include_data behaves in practice; only the verb "exporte" weakly implies a safe read.

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 zero padding or repetition. It is efficient, though the brevity borders on under-specification rather than tightness.

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 all three parameters are fully documented in the schema. What is missing is routing guidance against schema-reading siblings and any behavioral context, which matters since no annotations exist.

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 doc_id, format (including its allowed values), and include_data's 100-record limit all documented in the schema. The description adds no meaning beyond that, so the baseline 3 applies.

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?

"Exporte le schéma d'un document existant" supplies a specific verb (export) and resource (a document's schema), so the core action is unambiguous. It never contrasts itself with adjacent siblings such as get_table_schema or describe_document, so sibling differentiation is entirely absent.

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?

The only usage hint is the adjective "existant," implying the document must already exist. There is no statement of when to choose this over get_table_schema, describe_document, or download_document_excel, and no prerequisites or exclusions are given.

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