Skip to main content
Glama

Create request

request_create

Create a request: one assignment of a published form to one named recipient, with its own link, prefilled answers, expiry and optional callback. Use it when you need answers from a specific person and want to know whether they answered; for a link anyone may fill, use formShareLink_create. Call fields_list(formId) first — prefill/context/readonly take field keys. Returns { id, status, url, deliveryStatus, expiresAt, next }. Track with request_get, withdraw with request_cancel. See load_skill("requests").

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
testNoDry run. No invitation or reminder email whatever delivery says; the link still opens and can be completed; the callback fires with "test": true; the request is hidden from the Requests page and analytics by default and its submission counts nowhere (no quota, no exports, no integrations).
formIdYesPublished form to send. Call fields_list(formId) first for its keys.
contextNoValues for HIDDEN fields, keyed by field key: { "crm_id": "A-42" }. Only hidden-field keys (fields_list context: true); use metadata for others. Recipient cannot edit them, but sees mentioned ones.
prefillNoStarting answers for visible questions, keyed by field key. Shapes: string, number, "2026-03-01", "09:30", option KEY not label (see fields_list options), string[] of option keys (checkbox/ranking/picture-choice), { "row_key": "column_key" } (matrix), [{ "member_key": value }] (repeating group).
deliveryNo"none" (default) returns the link for you to deliver; "email" sends the invitation (needs recipient.email; Pro+, or one of Free's 10 free invitations).
domainIdNoMint the link on this custom domain; formShareLink_list returns the ids as availableCustomDomains.
languageNoPublished language tag the form opens in and the invitation is written in, e.g. "fr". Omit for the form default. The recipient can switch to any published language.
metadataNoOpaque JSON echoed on request_get and in the callback.
readonlyNoField keys the recipient may not edit. Each must also be in prefill.
documentsNoFiles for this one recipient, added below the block’s authored documents. See document_create.
expiresAtNoEpoch ms when the link dies. Default 30 days, max 365.
recipientNoWho this is for, e.g. { "email": "ada@acme.com", "name": "Ada" }.
remindersNoIdle-time offsets, e.g. ["2d","5d"] (max 5, units m/h/d). Omit to inherit the form schedule, [] for none. Needs recipient.email (Pro+).
externalIdNoYour own id; request_list filters on it.
callbackUrlNoPublic https endpoint POSTed on completion, expiry and cancellation, signed with X-Formstep-Signature. Private and loopback addresses are refused.
idempotencyKeyNoRetry-safe key, workspace-scoped for 30 days. Same key + same body returns the original request; a different body is a conflict.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/5.0
Behavior4/5

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

Annotations only declare readOnly/destructive/openWorld hints, so the description carries most of the behavioral burden and delivers: it names the emitted artifacts (invitation/reminder email, signed callback) and returns the created object shape, which compensates for the absent output schema. It stops short of covering permissions or quota edge cases beyond the cost note on 'email' delivery.

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 identity and scope, then usage, then prerequisite, then return shape, then lifecycle siblings. Every sentence carries distinct routing or behavioral information with no filler despite the tool's complexity.

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 16-param mutation tool with no output schema, the description supplies what is otherwise missing: the return fields ({ id, status, url, deliveryStatus, expiresAt, next }), the prerequisite call, and the tracking/withdrawal siblings. Nothing an agent needs to invoke it correctly is absent.

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 description coverage is 100% (baseline 3), and the description adds cross-parameter semantics the schema cannot: prefill/context/readonly all key off fields_list keys, and the fields_list call is a hard prerequisite. Most individual parameter meaning still lives in the schema, so it is a modest bump over baseline.

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?

States a precise verb and resource and immediately scopes it: 'one assignment of a published form to one named recipient, with its own link, prefilled answers, expiry and optional callback.' It explicitly contrasts with the sibling formShareLink_create ('for a link anyone may fill'), so an agent can pick between them 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 Guidelines5/5

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

Gives the when-to-use condition ('answers from a specific person and want to know whether they answered'), names the alternative and its selection condition, and adds a required prerequisite ('Call fields_list(formId) first'). It also routes follow-up work to request_get, request_cancel and load_skill('requests').

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.