Skip to main content
Glama

Generate a document from a form

submit_form

Submit a filled Xenition form (from find_forms) to generate its document. Saves the result to the user's workspace and returns it. Usually called by the form widget when the user clicks submit.

Input Schema

NameRequiredDescriptionDefault
titleNooptional title for the produced document
formIdYesthe form id from find_forms (e.g. 'invoice', 'resume')
valuesYesthe filled field values, keyed by field name; a list field is an array of objects keyed by its sub-field names

Output Schema

NameRequiredDescriptionDefault
artifactYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare the mutation/safety profile (readOnly=false, idempotent=false, destructive=false). The description adds real value beyond that by disclosing the side effect (result is saved to the user's workspace) and that the document is returned, which the annotations do not convey.

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 tight sentences, front-loaded with purpose, then side effect, then invocation context. Every sentence carries information an agent needs; no filler.

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?

An output schema exists, so return format needn't be explained, and the description covers purpose, side effect, and when it fires. For a 3-param tool with full schema coverage and annotations, nothing material 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 description coverage is 100%, so all three parameters (title, formId, values) are already documented, including the nested list-field convention. The description only reinforces that formId comes from find_forms; it adds no syntax or format detail beyond the schema, 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 (submit), resource (a filled Xenition form), and outcome (generate its document) in the first sentence. It also names the sibling that produces the formId (find_forms), so an agent can place it in the workflow without opening either 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?

Gives clear context for invocation — usually triggered by the form widget on user submit — and ties formId to find_forms. It does not name when NOT to use it or give alternatives (e.g. create_document for non-form generation), which keeps it short of a 5.

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.