Skip to main content
Glama

update_form

Conversationally edit a DRAFT form by instruction. Active forms are refused. Depending on the organization's settings, this either executes immediately or files a proposal for approval; the response status field says which happened.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
orgNoOrganization slug. Only needed when you belong to multiple organizations; must be one returned by list_my_orgs.
formIdYesThe draft form id to edit.
eventIdYesEvent id, as returned by list_events.
request_idYesClient-generated unique id for this write (e.g. a UUID). Retries with the same request_id return the original executed or proposed outcome instead of creating a duplicate. Never reuse a request_id for different arguments.
instructionYesThe natural-language edit instruction (e.g. 'rename the title', 'add a phone field').

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior5/5

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

The description goes well beyond the minimal annotations by disclosing that the tool operates conversationally, refuses active forms, and may either execute immediately or file an approval proposal depending on organization settings. It also tells the agent that the response status field indicates which path occurred, which is critical for interpreting the result.

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?

Three sentences, each earning its place: purpose, restriction, and execution-mode behavior. The most important distinguishing trait ('DRAFT form') is front-loaded, and the response-handling note is succinctly placed at the end. No filler or redundancy.

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 write tool with no output schema, the description adequately covers the behavioral nuances an agent needs: draft-only target, possible approval workflow, and how to determine the outcome. The schema covers parameter details, and no critical missing context remains for correct invocation.

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?

The input schema already provides 100% documentation coverage for all five parameters, including detailed descriptions for formId, eventId, request_id, and instruction. The description adds contextual framing around formId (draft-only) and instruction (natural-language edit), but does not add new parameter-level meaning beyond the schema.

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?

The description states a specific action ('edit'), a specific resource ('a DRAFT form'), and the mechanism ('by instruction'), making it distinct from create_form and update_form_pipeline. The additional 'Active forms are refused' clarifies the exact scope of the tool.

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 description clearly indicates when to use the tool: for draft forms only, with natural-language instructions. It explicitly calls out the exclusion of active forms, giving an unambiguous when-not. It does not name alternative tools for active-form edits, but the context is clear enough.

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