Skip to main content
Glama

Update field

update_field
DestructiveIdempotent

Patch a custom field by object_type + key — change its label or choice options. Returns the updated field definition.

When to use: When an admin wants to rename a custom field or change its choice options.

Example: Add 'reseller' to the partner_type field's options.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
keyYesThe custom field's key (from describe_schema), not its label.
labelNoNew display label. The key does not change.
optionsNoReplaces the whole choice list of a select/multiselect field, as labels; a choice field must keep at least one option.
object_typeYesObject key the field belongs to (built-in or custom).

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
fieldNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, destructiveHint=true, and idempotentHint=true, so the safety profile is covered. The description adds the mutation scope ('change its label or choice options') and a return note, but discloses nothing beyond annotations about auth needs or what the destructive replacement actually affects.

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?

Front-loaded with the core action, then a compact when-to-use line and a short example. Every sentence earns its place; only the explicit return note is mildly redundant given the output schema.

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 a low-complexity 4-parameter mutation tool, the description covers purpose, usage, and an example, while annotations handle safety and the output schema handles the return value. Auth/permission requirements are the only notable omission.

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 all four parameters are already documented, including the key-vs-label distinction and the option-replacement semantics. The description's 'by object_type + key' only restates schema content, so the baseline 3 is appropriate.

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?

States a specific verb (patch) and resource (custom field) plus the exact editable fields (label, choice options), identified by object_type + key. It's clear enough to distinguish from create-style siblings like define_field, though it never names them explicitly.

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

Usage Guidelines4/5

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

The explicit 'When to use' line gives a clear triggering context (admin renaming a field or changing its options) and an example. It lacks when-not guidance and does not route the agent to alternatives such as define_field or archive_field.

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.

Resources