Skip to main content
Glama

update_view_description

Idempotent

Change a view's description in Airtable. Specify the new description text, or clear it with an empty string.

Instructions

Update the description text of a view.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
appIdYesThe Airtable base/application ID
viewIdYesThe view ID (e.g. "viwXXX")
descriptionYesThe new description text. Use empty string to clear.
debugNoWhen true, include raw Airtable response in output for diagnostics

Implementation Reference

  • MCP tool schema definition for update_view_description. Defines input parameters: appId (base ID), viewId (view ID), description (text to set, empty string to clear), and optional debug flag.
    {
      name: 'update_view_description',
      description: 'Update the description text of a view.',
      annotations: { readOnlyHint: false, destructiveHint: false, idempotentHint: true, openWorldHint: false },
      inputSchema: {
        type: 'object',
        properties: {
          appId: { type: 'string', description: 'The Airtable base/application ID' },
          viewId: { type: 'string', description: 'The view ID (e.g. "viwXXX")' },
          description: { type: 'string', description: 'The new description text. Use empty string to clear.' },
          debug: debugProp,
        },
        required: ['appId', 'viewId', 'description'],
      },
    },
  • Handler function for the update_view_description tool. Delegates to client.updateViewDescription() and returns a success response with the viewId.
    async update_view_description({ appId, viewId, description, debug }) {
      const result = await client.updateViewDescription(appId, viewId, description);
      return ok(
        { updated: true, viewId },
        result,
        debug,
      );
    },
  • Client method that performs the actual HTTP call to Airtable's internal API. Validates IDs, POSTs to /v0.3/view/{viewId}/updateDescription with a description payload.
    async updateViewDescription(appId, viewId, description) {
      assertAirtableId(appId, 'appId');
      assertAirtableId(viewId, 'viewId');
      const url = `https://airtable.com/v0.3/view/${viewId}/updateDescription`;
      const payload = { description };
    
      const res = await this.auth.postForm(url, this._mutationParams(payload, appId), appId);
    
      if (!res.ok) {
        const errBody = await res.text().catch(() => '');
        throw new Error(`updateViewDescription failed (${res.status}): ${errBody}`);
      }
    
      return res.json();
    }
  • Tool category registration in TOOL_CATEGORIES — maps update_view_description to the 'view-write' permission category.
    update_view_description: 'view-write',
Behavior3/5

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

Annotations already indicate it's a non-destructive, idempotent write operation. Description adds no new behavioral context (e.g., that empty string clears, no side effects).

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 sentence, no unnecessary words. Efficient and front-loaded.

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 simple update tool with full schema and annotations, description is almost complete. Lacks output/error details but not critical given simplicity.

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 covers 100% of parameters with descriptions. Description adds no extra meaning beyond what schema provides.

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?

Clearly states action (update) and resource (description text of a view). Distinguishes from siblings like rename_view or update_view_filters.

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?

No explicit when-to-use or alternatives. Implied usage from name and description, but lacks guidance like 'use this to modify the description; for other view properties use respective tools.'

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