Skip to main content
Glama

Tommos

Update a Smart Form

update_form
Idempotent

Update a Smart Form's configuration — the same fields the form editor saves. Pass form (id or slug) plus only the fields to change. fields replaces the whole field list and must include one field named "email" of type "email". success_mode: "booking" needs an event_type_id from list_events (the booking step's hours and duration live on that event). Returns the updated form.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
formYesForm id or slug to update
nameNoInternal form name
slugNoPublic slug (a-z, 0-9, dashes); the embed snippet uses it
titleNoHeading shown on the widget
fieldsNoThe full field list, in order
subtitleNoMuted line under the title
is_activeNoPublished: true publishes what the form holds after this update (as publish_a_form does); false unpublishes it
consent_mdNoConsent / fine print, markdown (links allowed)
show_titleNo
create_dealNoAlso open a deal on the default pipeline
redirect_urlNohttp(s) URL (success_mode redirect)
submit_labelNoSubmit button text
success_modeNo
booking_introNo
event_type_idNoEvent to book after submit (success_mode booking)
notify_emailsNoWho gets the new-submission email
show_subtitleNo
captcha_enabledNo
consent_enabledNo
success_messageNoThank-you text (success_mode message)
consent_positionNoRelative to the submit button
booking_preheaderNo
confirmation_bodyNoPlain text; merge tags like {{name}} allowed
notification_introNo
confirmation_enabledNoEmail the submitter a confirmation
confirmation_subjectNo
confirmation_preheaderNo
notification_preheaderNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Annotations cover the safety profile (not read-only, idempotent, non-destructive), and the description adds traits the annotations cannot: `fields` replaces the entire list rather than merging, that list must contain an 'email' field of type 'email', and booking success mode requires an event_type_id whose hours/duration live on that event. It also states the return ('Returns the updated form').

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?

Four sentences, front-loaded with identity and scope, then the two hard constraints. No filler and every sentence carries an actionable rule.

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 28-parameter mutation with no output schema, the description covers the return value and the critical gotchas (full field replacement, required email field, booking dependency). It leaves many optional flags dependent on schema text alone, but nothing dangerous is unspecified.

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

Parameters4/5

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

With 28 parameters at 61% schema coverage, the description compensates by explaining the highest-risk semantics: how `form` accepts id or slug, that `fields` is a full replacement with a mandatory email entry, and the `success_mode: booking` / `event_type_id` linkage. It does not cover the remaining ~39% of undocumented parameters, so it stops short of a 5.

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?

States a specific verb and resource ('Update a Smart Form's configuration') and adds a frame of reference ('the same fields the form editor saves') that tells the agent exactly which surface it touches. This clearly separates it from create_a_form, delete_a_form, duplicate_a_form, and publish_a_form.

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?

Gives partial-update instruction ('Pass `form` (id or slug) plus only the fields to change') and a conditional dependency ('success_mode: "booking" needs an event_type_id from list_events'). It does not explicitly say when to prefer publish_a_form or get_form over this tool, so sibling routing is implied rather than stated.

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