Skip to main content
Glama

Modify Forms key set

forms_keysets_update
Idempotent

Update a form's key set settings by replacing the full record; requires name, total, and is_enabled, and total can only increase.

Instructions

Replace a key set's settings; returns the updated Keyset.

Despite the PATCH verb, the API validates the body as a full record: name, total and is_enabled must all be set or the request is rejected with 400. total can only grow: a number smaller than the set has now is refused.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyYesFull key set record — name, total and is_enabled are all required.
keyset_idYesKey set id (integer) from ``keysets_list``.
survey_idYesForm id (24-char hex) the key set belongs to.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.67.0

TDQS

A4.2/5.0
Behavior5/5

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

Goes well beyond the annotations (readOnly=false, destructive=false, idempotent=true) by disclosing a non-obvious API quirk: PATCH semantics but full-record validation, a 400 rejection when any field is missing, and the monotonic 'total can only grow' constraint. This is exactly the kind of behavioral context that prevents failed calls.

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?

Front-loads the core action and return value, then two tight sentences on the validation contract. No filler; every sentence carries a distinct constraint the agent cannot infer elsewhere.

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 mutation tool with no output schema (but a stated return) and annotations already covering the safety profile, the description supplies the missing validation and monotonicity constraints. An agent has everything needed to call it correctly.

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?

Schema coverage is 100% and the nested body already documents each field and the all-required rule, so baseline is 3. The description adds genuine meaning beyond the schema by explaining that all three fields must be set together and that total is monotonic and falsy on shrink.

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 (Replace) and resource (key set's settings) and notes the return value. It is clearly distinguishable from forms_keysets_create/delete/get by the verb, though it never names a sibling explicitly to route between them.

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?

The description tells the agent how the call behaves (full-record body required) but offers no explicit when-to-use vs alternatives guidance or prerequisites such as permission requirements. Usage is implied rather than directed.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools