dForms

Get a form

get_form

Read-onlyIdempotent

One form with its public_url, publish state and config. config is the editable version: the unpublished draft when there is one (config_source "draft"), else the live config. update_form takes an edited copy of all of config, with expected_updated_at = updated_at. When is_live is false the public link opens an empty form, so it is not ready to share. Webhooks and HubSpot are not part of the config: they are listed apart in destinations (with their ids, secrets masked) and changed with set_destinations.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "form_id": "<form_id>"
    },
    "name": "get_form"
  }
}

Input Schema

Name	Required	Description	Default
`form_id`	Yes	The form id, from list_forms or get_form.
`workspace_id`	No	The workspace this call acts in: an id from list_my_workspaces. Required for a person signed in with several workspaces and for staff of this deployment; optional with an API key or with only one workspace.

Output Schema

Name	Required	Description
`id`	Yes
`name`	Yes
`slug`	Yes
`config`	Yes	The config to edit and send back whole.
`is_live`	Yes	False when the live version has no steps: the form was never published with a question, so public_url opens an empty form and is not ready to share until publish_form makes a draft live. Null when unknown.
`folder_id`	Yes
`workspace`	Yes	The workspace this call acted in, to compare with the one the user means.
`created_at`	Yes
`editor_url`	Yes	The form in the dForms editor.
`public_url`	Yes	The exact link respondents open, to give to the user as returned (form links are not built by hand). Null when this deployment has no public address.
`updated_at`	Yes	Version stamp (epoch ms): the value expected_updated_at takes on update_form and publish_form.
`live_config`	No	Only when a draft is pending: what respondents see right now.
`destinations`	Yes	Where responses go now (webhooks and HubSpot), as stored on the live form, each with its id; signing secrets masked. The list set_destinations starts from: send it back whole with your change, a masked secret unchanged to keep it.
`config_source`	Yes
`live_step_count`	Yes	How many steps the live version has: what public_url serves now. Null when unknown.
`last_published_at`	Yes	When publish_form last made a draft live. Null when publish_form never ran: the form serves what it was created with, which is an empty form when is_live is false.
`has_unpublished_draft`	Yes	True when edits were saved with update_form but not published yet. The public form does not show them.
`previous_published_at`	Yes	When the version revert_form would bring back went live. Null when there is nothing to revert to.
`connected_destinations`	Yes	How many webhooks and HubSpot connections the form has (the length of destinations).

Schema Changelog

Changes observed during successful MCP inspections.

First observedNov 13, 2026

TDQS

A4.4/5.0

Behavior5/5

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

Annotations already cover readOnly/idempotent/non-destructive, and the description layers on real semantics the annotations cannot: which version of config is returned and how config_source signals it, the updated_at concurrency token, the shared-link consequence of is_live, and the fact that secrets are masked in `destinations`. This is exactly the extra context the dimension rewards.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

It front-loads the return surface and then moves to the config/update workflow and the destinations caveat in a logical order. It is dense but every clause carries information; the destination paragraph is slightly compressed but still readable.

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?

Even with an output schema present, the description explains the relationships (config vs destinations, draft vs live, updated_at for updates) that an agent needs to chain correctly into update_form or set_destinations. Nothing material for correct invocation is missing.

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%, including the workspace_id requirement conditions, so the schema already does the parameter work. The description adds no new meaning about form_id or workspace_id, so the baseline 3 applies.

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 opening sentence names a specific resource and enumerates what it returns (public_url, publish state, config), and the body sharpens that by defining `config` as the draft-or-live editable version. An agent can tell this apart from analytics/summary siblings without opening a schema.

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?

It gives concrete follow-on routing: use update_form with an edited copy of `config` and expected_updated_at = updated_at, and use set_destinations for webhooks/HubSpot rather than config. It also flags the practical condition that is_live=false means the public link shows an empty form and is not shareable. The only gap is no explicit contrast with get_form_summary or get_form_analytics.

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

All dForms tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?