Skip to main content
Glama
bim-ba

ycli

by bim-ba
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

Modify Forms survey

forms_surveys_update
Idempotent

Updates selected settings on an existing form and returns the updated survey; only fields you provide change, so partial patches are safe to repeat.

Instructions

Patch a form's settings — only the fields set in body change; returns the Survey.

Untouched settings keep their current values, so a partial patch is safe to repeat.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyYesTyped request body for modifying a form (``PATCH /surveys/{survey_id}``). Same optional fields as :class:`SurveyCreate`; only the fields you set are sent, so a partial patch never disturbs untouched settings.
survey_idYesForm id (24-char hex), from ``surveys_list``.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.122.1
    • changedInput schema / properties / body / properties / api_keys / anyOf
      Previous value: -[
-  {
-    "items": {
-      "additionalProperties": false,
-      "description": "An API key a form's integrations use (``api_keys`` item of a request).",
-      "properties": {
-        "id": {
-          "anyOf": [
-            {
-              "type": "string"
-            },
-            {
-              "type": "null"
-            }
-          ],
-          "default": null,
-          "description": "Id of an existing key."
-        },
-        "name": {
-          "description": "Name of the key.",
-          "type": "string"
-        },
-        "secure": {
-          "anyOf": [
-            {
-              "type": "boolean"
-            },
-            {
-              "type": "null"
-            }
-          ],
-          "default": null,
-          "description": "Whether the value is stored encrypted (the API's default)."
-        },
-        "value": {
-          "anyOf": [
-            {
-              "type": "string"
-            },
-            {
-              "type": "null"
-            }
-          ],
-          "default": null,
-          "description": "Value of the key."
-        }
-      },
-      "required": [
-        "name"
-      ],
-      "type": "object"
-    },
-    "type": "array"
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "items": {
+      "additionalProperties": false,
+      "description": "An API key a form's integrations use (``api_keys`` item of a request).",
+      "properties": {
+        "id": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "default": null,
+          "description": "Id of an existing key."
+        },
+        "name": {
+          "description": "Name of the key.",
+          "type": "string"
+        },
+        "secure": {
+          "anyOf": [
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "default": null,
+          "description": "Whether the value is stored encrypted (the API's default)."
+        },
+        "value": {
+          "anyOf": [
+            {
+              "format": "password",
+              "type": "string",
+              "writeOnly": true
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "default": null,
+          "description": "Value of the key: a secret, sent and never printed."
+        }
+      },
+      "required": [
+        "name"
+      ],
+      "type": "object"
+    },
+    "type": "array"
+  },
+  {
+    "type": "null"
+  }
+]
  2. First observedv0.67.0

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare idempotentHint=true, destructiveHint=false, and readOnlyHint=false, so safety is covered. The description usefully elaborates the PATCH gesture — only set fields change, untouched settings persist, and repetition is safe — adding context beyond the annotations, though it does not mention auth requirements or error behavior.

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?

Two tight sentences, the mutation semantics front-loaded ('only the fields set in body change') followed by the safety consequence. Nothing is wasted.

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?

With no output schema, the description earns credit for noting that it returns the Survey. For a nested-object PATCH tool with full schema coverage and safety annotations, this is nearly complete, though it omits permission/auth prerequisites.

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 coverage is 100% and the nested body schema already documents that only set fields are sent. The description reinforces this but adds no new syntax, format, or enumeration guidance for survey_id or the body fields, so the baseline 3 is appropriate.

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 and resource ('Patch a form's settings') and clarifies the partial-update semantics, which distinguishes it from siblings like forms_surveys_create or forms_surveys_get. It never names a sibling explicitly, so sibling differentiation is inferred rather than stated.

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 implies when to use it (when you want to change some, not all, settings) via the partial-patch framing, but there is no explicit when-to-use, when-not, or pointer to alternatives such as forms_surveys_publish for publication state. Usage context is implied only.

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