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. 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"
      +}
  2. 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"
      +}
  3. 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"
  4. 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"
      +}
  5. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare read-only and non-destructive behavior, so the description doesn't need to cover side effects. It adds useful behavioral context by stating the sequential ordering guarantee, the inclusion of routing, and the data provenance from clipform_set_logic, which goes beyond the bare annotation.

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 tightly packed sentences with no filler. The action and resource are front-loaded, and the second sentence enumerates the return components efficiently. Every clause adds useful information.

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 an output schema, annotations, and 100% parameter coverage, the description is complete enough for a read-only retrieval tool. It explains the return scope and ordering, though it stops short of explicitly routing agents away from sibling tools or mentioning edge cases like missing forms or empty node lists.

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%, and both required parameters are individually explained (including distinguishing form_id from the short share_id). The tool description does not add any parameter-specific meaning beyond what the schema already provides, so the baseline 3 is appropriate.

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 uses a specific verb ('Retrieve') and resource ('a form's details'), and adds precise scope: all nodes in sequential order, their routing, title, settings, options, config, media status, and next node. This clearly distinguishes it from listing tools or workflow-specific tools among the siblings.

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 intended use is implied by the detailed return description, and the mention of 'from clipform_set_logic' hints at the read counterpart of that tool. However, there is no explicit when-to-use/when-not-to-use guidance or named alternative, so an agent must infer the boundary against sibling tools like clipform_list_forms or clipform_get_workflow.

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.