Skip to main content
Glama
Grist MCP Server
by nic01asFr

Create Reference Column

create_reference_column

Creates a Grist reference column that displays a selected column from a target table and optionally adds a synchronized reverse reference column.

Instructions

Crée une colonne de référence qui affiche la colonne choisie de la table cible.

Cette fonction:

  1. Vérifie que les tables source et cible existent

  2. Résout le nom (ID ou libellé) de la colonne visible

  3. Crée la colonne de référence et règle son affichage

  4. Optionnellement crée la relation inverse (référence à double sens Grist : les deux colonnes restent synchronisées)

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>",
      "table_id": "<table_id>",
      "column_id": "<column_id>",
      "target_table": "<target_table>",
      "visible_column": "<visible_column>"
    },
    "name": "create_reference_column"
  }
}

Input Schema

NameRequiredDescriptionDefault
labelNoLibellé d'affichage (optionnel)
doc_idYesL'ID du document
is_listNoSi True, crée RefList au lieu de Ref (défaut: False)
table_idYesL'ID de la table source
column_idYesID de la nouvelle colonne de référence
target_tableYesID de la table cible
reverse_columnNoSi fourni, ID de la colonne inverse (RefList) créée dans target_table
visible_columnYesID ou libellé de la colonne à afficher (table cible)

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed8 schema fields changedv0.2.2
    • addedInput schema / properties / column_id / description
      Added value: +"ID de la nouvelle colonne de référence"
    • addedInput schema / properties / doc_id / description
      Added value: +"L'ID du document"
    • addedInput schema / properties / is_list / description
      Added value: +"Si True, crée RefList au lieu de Ref (défaut: False)"
    • addedInput schema / properties / label / description
      Added value: +"Libellé d'affichage (optionnel)"
    • addedInput schema / properties / reverse_column / description
      Added value: +"Si fourni, ID de la colonne inverse (RefList) créée dans target_table"
    • addedInput schema / properties / table_id / description
      Added value: +"L'ID de la table source"
    • addedInput schema / properties / target_table / description
      Added value: +"ID de la table cible"
    • addedInput schema / properties / visible_column / description
      Added value: +"ID ou libellé de la colonne à afficher (table cible)"
  2. First observedv0.1.0

TDQS

A3.8/5.0
Behavior4/5

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

With no annotations at all, the description carries the full burden and does meaningful work: it discloses validation of source/target tables, name resolution of the visible column, display setup, and that reverse_column creates a synchronized two-way Grist reference. It omits failure modes such as what happens if the column ID already exists, idempotency, and required write permissions.

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?

One front-loaded sentence giving purpose, followed by four short ordered steps with no filler. Every sentence conveys a distinct behavior, and the optional reverse-relation case is called out separately.

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

Completeness4/5

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

For an 8-parameter mutation tool with no annotations and a present output schema, the description covers the operation's flow and the notable two-way-reference side effect. The main remaining gap is the absence of selection guidance against the sibling column tools, which is a usage rather than a completeness concern.

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 every parameter is already documented, including reverse_column and visible_column semantics; the baseline of 3 applies. The description reinforces that visible_column accepts ID or label and that reverse_column is optional, but adds no syntax or format detail beyond the schema.

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 ('Crée une colonne de référence qui affiche la colonne choisie de la table cible'), which is clearly distinct from a plain create_column. It does not explicitly name create_column as the alternative, so sibling differentiation is implied rather than stated.

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

Usage Guidelines3/5

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

Usage is only implied: the agent can infer this is for building Ref/RefList columns between two tables, but there is no explicit when-to-use versus create_column or modify_column, and no stated prerequisites or exclusions. The numbered list describes execution steps rather than guidance for choosing the tool.

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