Skip to main content
Glama
nic01asFr
by nic01asFr

export_schema

Export a document's schema in JSON, YAML, or Mermaid format. Optionally include data (limited to 100 records per table).

Instructions

Exporte le schéma d'un document existant.

Args: doc_id: L'ID du document format: Format d'export ("json", "yaml", "mermaid") include_data: Si True, inclut les données (limité à 100 enregistrements/table)

Returns: Dict avec le schéma exporté dans le format demandé

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
doc_idYes
formatNojson
include_dataNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior3/5

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

With no annotations, the description must disclose behavior. It mentions the export action and the optional include_data parameter's 100-record limit. However, it does not confirm whether the operation is read-only or requires specific permissions, leaving some behavioral gaps.

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 extremely concise, using a clear header and bullet-like args/returns. Every sentence adds value, with no redundancy or filler.

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?

The description covers inputs and return value but omits prerequisites (e.g., document existence) and error conditions. Given the simplicity and presence of output schema, it is adequate but not fully complete.

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?

Despite 0% schema coverage, the description explains all three parameters: doc_id, format (listing values json, yaml, mermaid), and include_data (limiting to 100 records). This adds meaning beyond the schema's bare types and defaults.

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 the tool exports the schema of an existing document, using a specific verb and resource. It distinguishes from sibling tools like 'create_schema' or 'get_table_schema' by focusing on export in various formats.

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 description provides no guidance on when to use this tool versus alternatives, nor any exclusions or context. It simply states what it does, leaving the agent to infer usage.

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