Skip to main content
Glama

Get Clipform

clipform_get_form
Read-onlyIdempotent

Retrieve a form's details including all nodes in sequential order and their routing. Returns title, settings, and every node with its options, config, media status, and next node (from clipform_set_logic).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
contextYesDescribe the user's underlying goal in one sentence - not the tool you're calling.
form_idYesThe form UUID (returned by clipform_create_form, not the short share_id from the URL)

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlsNoDashboard/viewer deeplinks for this form. An anonymous caller gets only 'viewer'.
nodesYesNodes in sequential order - IDs for update_node / attach_node_media
titleYesForm title
form_idYesForm UUID
is_liveYesWhether the form is published
has_unpublished_changesYesLive form has edits not yet republished

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / properties / urls / properties / viewer / description
      Previous value: -"Live respondent link, or a scoped preview link for an anonymous caller's draft. Omitted for a non-anonymous caller's unpublished draft."New value: +"Live respondent link, or - for an anonymous caller's draft - a private preview link where answers are not saved (do not share it with respondents). Omitted for a non-anonymous caller's unpublished draft."
  2. Changed2 schema fields changed
    • addedInput schema / properties / form_id / pattern
      Added value: +"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    • addedOutput schema / properties / nodes / items / properties / config / propertyNames
      Added value: +{
      +  "type": "string"
      +}
  3. Changed4 schema fields changed
    • removedInput schema / additionalProperties
      Removed value: -false
    • addedInput schema / properties / context
      Added value: +{
      +  "description": "Describe the user's underlying goal in one sentence - not the tool you're calling.",
      +  "type": "string"
      +}
    • changedInput schema / required
      Previous value: -[
      -  "form_id"
      -]New value: +[
      +  "form_id",
      +  "context"
      +]
    • addedOutput schema / properties / urls
      Added value: +{
      +  "additionalProperties": false,
      +  "description": "Dashboard/viewer deeplinks for this form. An anonymous caller gets only 'viewer'.",
      +  "properties": {
      +    "analytics": {
      +      "description": "Analytics tab - views, starts, completion rate, drop-off per node. Not present for an anonymous caller.",
      +      "type": "string"
      +    },
      +    "builder": {
      +      "description": "Build tab - the node/canvas editor. Not present for an anonymous caller.",
      +      "type": "string"
      +    },
      +    "dynamic_link": {
      +      "description": "Dynamic/personalized link setup. Not present for an anonymous caller.",
      +      "type": "string"
      +    },
      +    "embed": {
      +      "description": "Embed setup for websites. Not present for an anonymous caller.",
      +      "type": "string"
      +    },
      +    "responses": {
      +      "description": "Responses tab - individual submissions. Not present for an anonymous caller.",
      +      "type": "string"
      +    },
      +    "share": {
      +      "description": "Share tab - link, QR, social. Not present for an anonymous caller.",
      +      "type": "string"
      +    },
      +    "summary": {
      +      "description": "Summary tab - form overview and key stats. Not present for an anonymous caller.",
      +      "type": "string"
      +    },
      +    "viewer": {
      +      "description": "Live respondent link, or a scoped preview link for an anonymous caller's draft. Omitted for a non-anonymous caller's unpublished draft.",
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  4. Changed1 schema field changed
    • addedOutput schema / properties / nodes / items / properties / next
      Added value: +{
      +  "additionalProperties": false,
      +  "description": "This node's outgoing edge, set via clipform_set_logic. Omitted for a chain tail or terminal node.",
      +  "properties": {
      +    "target_id": {
      +      "description": "The node/screen ID this node routes to",
      +      "type": "string"
      +    },
      +    "target_type": {
      +      "description": "What kind of target target_id is",
      +      "enum": [
      +        "node",
      +        "end_screen",
      +        "redirect",
      +        "link_list"
      +      ],
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "target_id",
      +    "target_type"
      +  ],
      +  "type": "object"
      +}
  5. Changed1 schema field changed
    • changedOutput schema / properties / nodes / description
      Previous value: -"Nodes in sequential order - IDs for update_node / upload_node_media"New value: +"Nodes in sequential order - IDs for update_node / attach_node_media"
  6. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": false,
      +  "properties": {
      +    "form_id": {
      +      "description": "Form UUID",
      +      "type": "string"
      +    },
      +    "has_unpublished_changes": {
      +      "description": "Live form has edits not yet republished",
      +      "type": "boolean"
      +    },
      +    "is_live": {
      +      "description": "Whether the form is published",
      +      "type": "boolean"
      +    },
      +    "nodes": {
      +      "description": "Nodes in sequential order - IDs for update_node / upload_node_media",
      +      "items": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "config": {
      +            "additionalProperties": {},
      +            "type": "object"
      +          },
      +          "id": {
      +            "type": "string"
      +          },
      +          "options": {
      +            "items": {
      +              "additionalProperties": false,
      +              "properties": {
      +                "content": {
      +                  "type": "string"
      +                },
      +                "id": {
      +                  "type": "string"
      +                }
      +              },
      +              "required": [
      +                "id",
      +                "content"
      +              ],
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "prompt": {
      +            "type": "string"
      +          },
      +          "required": {
      +            "type": "boolean"
      +          },
      +          "type": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "id",
      +          "type",
      +          "prompt",
      +          "required"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "title": {
      +      "description": "Form title",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "form_id",
      +    "title",
      +    "is_live",
      +    "has_unpublished_changes",
      +    "nodes"
      +  ],
      +  "type": "object"
      +}
  7. First observed

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so the safety profile is fully covered. The description adds some value by naming the returned fields (title, settings, node options/config/media status/next node) and attributing the routing to clipform_set_logic, but it discloses no auth, rate-limit, or failure behavior beyond what annotations and the output schema provide.

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, front-loaded with the primary purpose and then the return contents. Every clause carries information and nothing is padded.

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 rich annotations and a dedicated output schema, the definition only needs to orient the agent, which it does. The return-value description is somewhat redundant against the output schema, but the purpose and scope are complete enough to call the tool correctly.

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 description coverage is 100%, so both form_id and context are already documented (including the useful note that form_id is not the short share_id). The description adds no parameter-level meaning beyond the schema, so the baseline of 3 applies.

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 (Retrieve) and resource (a form's details), and scopes the content precisely: all nodes in sequential order plus their routing. It is clearly a single-form read tool, distinguishable from clipform_list_forms and clipform_get_workflow, though it never names those siblings explicitly.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no guidance on when to call this versus alternatives such as clipform_get_workflow or clipform_list_forms, nor any stated prerequisites. The usage context is only weakly implied by the content it returns.

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.