Skip to main content
Glama

update_field_description

Idempotent

Modify field descriptions in Airtable bases to improve documentation and clarify data usage for team members.

Instructions

Update the description text of a field.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
appIdYesThe Airtable base/application ID
fieldIdYesThe field/column ID (e.g. "fldXXX")
descriptionYesThe new description text
debugNoWhen true, include raw Airtable response in output for diagnostics
Behavior3/5

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

Annotations already provide key behavioral traits: readOnlyHint=false (mutation), destructiveHint=false (non-destructive), idempotentHint=true (safe to retry), and openWorldHint=false (closed system). The description adds minimal value beyond confirming it's an update operation. It doesn't disclose additional context like permission requirements, rate limits, or what happens to existing data. No contradiction with annotations exists.

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 a single, efficient sentence with zero wasted words. It's front-loaded with the core action and resource, making it immediately scannable. Every word earns its place by directly contributing to understanding the tool's purpose without redundancy or fluff.

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?

Given the mutation nature (readOnlyHint=false), 100% schema coverage, and no output schema, the description is minimally adequate. It covers the basic 'what' but lacks context on 'why' or 'how'—such as error conditions, response format, or integration with sibling tools. For a tool that modifies data, more behavioral context would be beneficial, but annotations provide safety assurances.

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 clear documentation for all four parameters (appId, fieldId, description, debug). The description adds no parameter-specific information beyond implying 'field' and 'description' are involved. Since the schema fully covers parameter meanings, the baseline score of 3 is appropriate, as the description doesn't enhance or clarify beyond what's already structured.

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 clearly states the action ('Update') and resource ('description text of a field'), making the purpose immediately understandable. It distinguishes from siblings like 'update_field_config' or 'rename_field' by focusing specifically on description text. However, it doesn't explicitly mention the Airtable context or differentiate from 'update_view_description' beyond the field vs. view distinction.

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 like 'update_field_config' or 'rename_field'. It doesn't mention prerequisites (e.g., needing appId and fieldId), nor does it clarify when this operation is appropriate versus creating a new field. The absence of usage context leaves the agent to infer from parameter names alone.

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/Automations-Project/VSCode-Airtable-Formula'

If you have feedback or need assistance with the MCP directory API, please join our Discord server