Skip to main content
Glama

update_field

Destructive

Modifies one existing field (column) of an ERD entity, found by its field id: name, type, nullable, isPrimaryKey, isUnique, defaultValue, description, order. Only the fields provided change; null on defaultValue or description clears it. The field cannot move to another entity and its id cannot change. A type of kind 'reference' requires an existing target (referencesCellId + referencesFieldId), otherwise the call is REFUSED with an error and nothing is written (an unknown field id is refused the same way); the relation itself is created by add_relation (with its cardinality). Changing a field away from 'reference' DELETES the relations that used it as their source, and the response does not list them: get_full_data, called beforehand, shows what would go. order positions this field only; the complete order of an entity is set by reorder_fields. add_field adds a field, delete_field removes one, update_entity changes the table itself.

Input Schema

NameRequiredDescriptionDefault
idYesID of the field to modify (read the field ids with list_entities and includeFields=true)
nameNoNew name of the field (column name)
typeNoNew type, discriminated by kind. E.g. { kind: "string", length: 255 }. kind "reference" (FK) requires referencesCellId and referencesFieldId of an existing target field; an absent type keeps the current one.
orderNoDisplay order index (integer) of this field only; reorder_fields sets the complete order of an entity
isUniqueNotrue = UNIQUE constraint on the field
nullableNotrue = the column accepts NULL
descriptionNoDocumentation of the field; null clears it, omitted leaves it as is
defaultValueNoDefault value as a SQL expression string; null clears it, omitted leaves it as is
isPrimaryKeyNotrue = the field is (part of) the primary key
expectedProjectIdNoUUID of the project targeted by THIS call. ACTUALLY targets this project instead of the session project. Refused without changing anything if access is not granted.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed9 schema fields changed
    • addedInput schema / properties / defaultValue / description
      Added value: +"Default value as a SQL expression string; null clears it, omitted leaves it as is"
    • addedInput schema / properties / description / description
      Added value: +"Documentation of the field; null clears it, omitted leaves it as is"
    • addedInput schema / properties / id / description
      Added value: +"ID of the field to modify (read the field ids with list_entities and includeFields=true)"
    • addedInput schema / properties / isPrimaryKey / description
      Added value: +"true = the field is (part of) the primary key"
    • addedInput schema / properties / isUnique / description
      Added value: +"true = UNIQUE constraint on the field"
    • addedInput schema / properties / name / description
      Added value: +"New name of the field (column name)"
    • addedInput schema / properties / nullable / description
      Added value: +"true = the column accepts NULL"
    • addedInput schema / properties / order / description
      Added value: +"Display order index (integer) of this field only; reorder_fields sets the complete order of an entity"
    • addedInput schema / properties / type / description
      Added value: +"New type, discriminated by kind. E.g. { kind: \"string\", length: 255 }. kind \"reference\" (FK) requires referencesCellId and referencesFieldId of an existing target field; an absent type keeps the current one."
  2. Changed2 schema fields changed
    • changedInput schema / properties / expectedProjectId / description
      Previous value: -"UUID du projet visé par CET appel. Cible RÉELLEMENT ce projet au lieu du projet de session. Refusé sans rien modifier si l'accès n'est pas accordé."New value: +"UUID of the project targeted by THIS call. ACTUALLY targets this project instead of the session project. Refused without changing anything if access is not granted."
    • changedInput schema / properties / type / oneOf
      Previous value: -[
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "kind": {
      -        "const": "string",
      -        "type": "string"
      -      },
      -      "length": {
      -        "exclusiveMinimum": 0,
      -        "maximum": 9007199254740991,
      -        "type": "integer"
      -      }
      -    },
      -    "required": [
      -      "kind"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "kind": {
      -        "const": "text",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "kind"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "kind": {
      -        "const": "int",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "kind"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "kind": {
      -        "const": "bigint",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "kind"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "kind": {
      -        "const": "float",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "kind"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "kind": {
      -        "const": "boolean",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "kind"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "kind": {
      -        "const": "uuid",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "kind"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "kind": {
      -        "const": "date",
      -        "type": "string"
      -      },
      -      "withTimezone": {
      -        "type": "boolean"
      -      }
      -    },
      -    "required": [
      -      "kind"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "kind": {
      -        "const": "timestamp",
      -        "type": "string"
      -      },
      -      "withTimezone": {
      -        "type": "boolean"
      -      }
      -    },
      -    "required": [
      -      "kind"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "kind": {
      -        "const": "jsonb",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "kind"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "kind": {
      -        "const": "enum",
      -        "type": "string"
      -      },
      -      "values": {
      -        "description": "La liste COMPLÈTE des valeurs de l'énumération — elle REMPLACE celle qui est stockée. Pour en ajouter une, toutes les valeurs existantes (lisibles sur le champ) se renvoient avec la nouvelle.",
      -        "items": {
      -          "minLength": 1,
      -          "type": "string"
      -        },
      -        "minItems": 1,
      -        "type": "array"
      -      }
      -    },
      -    "required": [
      -      "kind",
      -      "values"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "kind": {
      -        "const": "reference",
      -        "type": "string"
      -      },
      -      "referencesCellId": {
      -        "minLength": 1,
      -        "type": "string"
      -      },
      -      "referencesFieldId": {
      -        "minLength": 1,
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "kind",
      -      "referencesCellId",
      -      "referencesFieldId"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "kind": {
      +        "const": "string",
      +        "type": "string"
      +      },
      +      "length": {
      +        "exclusiveMinimum": 0,
      +        "maximum": 9007199254740991,
      +        "type": "integer"
      +      }
      +    },
      +    "required": [
      +      "kind"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "kind": {
      +        "const": "text",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "kind"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "kind": {
      +        "const": "int",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "kind"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "kind": {
      +        "const": "bigint",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "kind"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "kind": {
      +        "const": "float",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "kind"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "kind": {
      +        "const": "boolean",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "kind"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "kind": {
      +        "const": "uuid",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "kind"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "kind": {
      +        "const": "date",
      +        "type": "string"
      +      },
      +      "withTimezone": {
      +        "type": "boolean"
      +      }
      +    },
      +    "required": [
      +      "kind"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "kind": {
      +        "const": "timestamp",
      +        "type": "string"
      +      },
      +      "withTimezone": {
      +        "type": "boolean"
      +      }
      +    },
      +    "required": [
      +      "kind"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "kind": {
      +        "const": "jsonb",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "kind"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "kind": {
      +        "const": "enum",
      +        "type": "string"
      +      },
      +      "values": {
      +        "description": "The COMPLETE list of the enumeration's values — it REPLACES the stored one. To add one, all the existing values (readable on the field) are sent back along with the new one.",
      +        "items": {
      +          "minLength": 1,
      +          "type": "string"
      +        },
      +        "minItems": 1,
      +        "type": "array"
      +      }
      +    },
      +    "required": [
      +      "kind",
      +      "values"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "kind": {
      +        "const": "reference",
      +        "type": "string"
      +      },
      +      "referencesCellId": {
      +        "minLength": 1,
      +        "type": "string"
      +      },
      +      "referencesFieldId": {
      +        "minLength": 1,
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "kind",
      +      "referencesCellId",
      +      "referencesFieldId"
      +    ],
      +    "type": "object"
      +  }
      +]
  3. Changed1 schema field changed
    • changedInput schema / properties / type / oneOf
      Previous value: -[
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "kind": {
      -        "const": "string",
      -        "type": "string"
      -      },
      -      "length": {
      -        "exclusiveMinimum": 0,
      -        "maximum": 9007199254740991,
      -        "type": "integer"
      -      }
      -    },
      -    "required": [
      -      "kind"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "kind": {
      -        "const": "text",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "kind"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "kind": {
      -        "const": "int",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "kind"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "kind": {
      -        "const": "bigint",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "kind"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "kind": {
      -        "const": "float",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "kind"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "kind": {
      -        "const": "boolean",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "kind"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "kind": {
      -        "const": "uuid",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "kind"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "kind": {
      -        "const": "date",
      -        "type": "string"
      -      },
      -      "withTimezone": {
      -        "type": "boolean"
      -      }
      -    },
      -    "required": [
      -      "kind"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "kind": {
      -        "const": "timestamp",
      -        "type": "string"
      -      },
      -      "withTimezone": {
      -        "type": "boolean"
      -      }
      -    },
      -    "required": [
      -      "kind"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "kind": {
      -        "const": "jsonb",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "kind"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "kind": {
      -        "const": "enum",
      -        "type": "string"
      -      },
      -      "values": {
      -        "description": "La liste COMPLÈTE des valeurs de l'énumération — elle REMPLACE celle qui est stockée. Pour en ajouter une, relis le champ et renvoie toutes les valeurs existantes avec la nouvelle.",
      -        "items": {
      -          "minLength": 1,
      -          "type": "string"
      -        },
      -        "minItems": 1,
      -        "type": "array"
      -      }
      -    },
      -    "required": [
      -      "kind",
      -      "values"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "kind": {
      -        "const": "reference",
      -        "type": "string"
      -      },
      -      "referencesCellId": {
      -        "minLength": 1,
      -        "type": "string"
      -      },
      -      "referencesFieldId": {
      -        "minLength": 1,
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "kind",
      -      "referencesCellId",
      -      "referencesFieldId"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "kind": {
      +        "const": "string",
      +        "type": "string"
      +      },
      +      "length": {
      +        "exclusiveMinimum": 0,
      +        "maximum": 9007199254740991,
      +        "type": "integer"
      +      }
      +    },
      +    "required": [
      +      "kind"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "kind": {
      +        "const": "text",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "kind"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "kind": {
      +        "const": "int",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "kind"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "kind": {
      +        "const": "bigint",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "kind"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "kind": {
      +        "const": "float",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "kind"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "kind": {
      +        "const": "boolean",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "kind"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "kind": {
      +        "const": "uuid",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "kind"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "kind": {
      +        "const": "date",
      +        "type": "string"
      +      },
      +      "withTimezone": {
      +        "type": "boolean"
      +      }
      +    },
      +    "required": [
      +      "kind"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "kind": {
      +        "const": "timestamp",
      +        "type": "string"
      +      },
      +      "withTimezone": {
      +        "type": "boolean"
      +      }
      +    },
      +    "required": [
      +      "kind"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "kind": {
      +        "const": "jsonb",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "kind"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "kind": {
      +        "const": "enum",
      +        "type": "string"
      +      },
      +      "values": {
      +        "description": "La liste COMPLÈTE des valeurs de l'énumération — elle REMPLACE celle qui est stockée. Pour en ajouter une, toutes les valeurs existantes (lisibles sur le champ) se renvoient avec la nouvelle.",
      +        "items": {
      +          "minLength": 1,
      +          "type": "string"
      +        },
      +        "minItems": 1,
      +        "type": "array"
      +      }
      +    },
      +    "required": [
      +      "kind",
      +      "values"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "kind": {
      +        "const": "reference",
      +        "type": "string"
      +      },
      +      "referencesCellId": {
      +        "minLength": 1,
      +        "type": "string"
      +      },
      +      "referencesFieldId": {
      +        "minLength": 1,
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "kind",
      +      "referencesCellId",
      +      "referencesFieldId"
      +    ],
      +    "type": "object"
      +  }
      +]
  4. First observed

TDQS

A4.9/5.0
Behavior5/5

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

Goes well beyond the destructiveHint=true annotation: it states that a reference type without an existing target is REFUSED with nothing written, that unknown ids are refused the same way, and — critically — that moving a field away from 'reference' DELETES dependent relations without listing them in the response. It also discloses immutability constraints (id and parent entity cannot change) and partial-update semantics.

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?

Dense but well-structured, with the destructive relation-deletion warning and the refusal behavior front-loaded. The single long opening sentence listing eight attributes is slightly heavy, but no sentence is filler.

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

Completeness5/5

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

For a 10-parameter mutation tool with no output schema, the description covers atomicity, error conditions, side effects, and post-mutation state. An agent has everything needed to invoke it safely without opening the schema.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is already 100%, yet the description still adds semantics the schema lacks: omitted fields are unchanged, explicit null clears defaultValue/description, type 'reference' requires a pre-existing target, and `order` is per-field only. This compensates for the deep oneOf type union by explaining its key branch.

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?

Opens with a specific verb+resource+scope: modifies ONE existing field of an ERD entity, identified by field `id`, and enumerates the mutable attributes. It is immediately distinguishable from add_field, delete_field, and update_entity, which are named later.

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

Usage Guidelines5/5

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

Explicitly routes the agent: relations are created by add_relation, not here; complete ordering is reorder_fields while `order` positions only this field; add_field/delete_field/update_entity cover the other operations. It also names get_full_data as a prerequisite step to inspect relations that would be deleted.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.