Skip to main content
Glama

Create Forms key set

forms_keysets_create

Create a batch of single-use personal-link keys for a form and return the new key set. Set is_enabled, name, and total; download generated keys via CLI.

Instructions

Create a batch of single-use personal-link keys on a form; returns the created Keyset.

The API rejects a body without is_enabled, so set it explicitly alongside name and total. Download the generated keys via the forms keysets download CLI command (binary payload — not exposed over MCP).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyYesKey set settings; the API requires ``is_enabled`` on create.
survey_idYesForm id (24-char hex) to add the key set to.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.67.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations declare the mutation profile (readOnlyHint=false, idempotentHint=false, destructiveHint=false), so the description doesn't need to restate safety. It does add valuable context beyond the annotations: the required is_enabled field that the API enforces and the fact that generated keys cannot be retrieved over MCP (CLI-only, binary payload).

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?

Three short sentences with no filler; the purpose and return value come first, followed by the hard requirement and the follow-up retrieval path. Every sentence earns its place.

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 correctly notes it returns a Keyset, and it flags the important limitation that the generated keys are not retrievable via MCP. Complete enough to call correctly, though it never mentions pagination or mutations-vs-idempotency considerations for retries.

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 coverage is 100%, so the baseline is 3, but the description adds real meaning: it warns that is_enabled must be set explicitly even though the schema shows it defaulting to null, and ties it to name/total in the body. That maps directly to parameters the agent could otherwise get wrong.

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 specific verb ('Create'), resource ('batch of single-use personal-link keys on a form'), and return value ('returns the created Keyset'). An agent can distinguish it from forms_keysets_list/get/update/delete purely from the description.

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?

Gives a hard prerequisite ('the API rejects a body without is_enabled') and routes the agent elsewhere for the output ('download the generated keys via the forms keysets download CLI command'), which is genuinely actionable. It does not, however, contrast this tool against sibling operations like forms_keysets_update, so it stops short of explicit when/when-not guidance.

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