Skip to main content
Glama

AssetLab

Create form template

create_form_template

Create a form template - a reusable inspection, checklist, compliance, or survey definition. Step 1 of building a form: create it as a draft, then add questions with create_form_template_item (or bulk_create on form-template-items), then publish with update_form_template status=published (publishing is rejected if any question is malformed). Requires form_templates:write scope.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesForm template name (required)
moduleNoWorkspace the form is offered in: facilities, infrastructure (inspections of features), or shared (both). Defaults to shared.
statusNoPublication status - leave as draft (default) until all questions are added.
descriptionNoDescription
work_category_idNoWork category ID - the same tenant-configured categories used by work orders (e.g. Electrical, Plumbing, HVAC). Look them up with list_work_categories and pick the closest match; omit if none fits.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare the mutation profile (readOnlyHint=false, non-idempotent, non-destructive), and the description adds genuine context beyond them: the draft-then-publish lifecycle, the validation gate on publish, and the required form_templates:write scope. It stops short of describing the response, which keeps it below a perfect score.

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 the definition, then a compact ordered sequence of steps with no redundant sentences. Every clause (workflow order, alternative bulk path, publish gate, scope) earns its place.

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 create tool with no output schema and full schema coverage, the description supplies everything an agent needs: what the object is, the multi-step workflow it belongs to, the publishing constraint, and the auth scope.

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 name, module, status, description, and work_category_id are all already documented in the schema. The description adds no field-level syntax or constraints, 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?

States a specific verb+resource ('Create a form template') and then defines the domain object concretely as 'a reusable inspection, checklist, compliance, or survey definition', which distinguishes it from siblings like create_form_response or create_pm_template.

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?

Explicitly frames the tool as 'Step 1' of a multi-step workflow and names the exact follow-up tools (create_form_template_item, bulk_create on form-template-items, update_form_template status=published), including the condition that publishing is rejected if a question is malformed.

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.

Resources