Skip to main content
Glama

form_fetch_model

Generates a request form model from a library schema, enabling VCF Automation clients to render and validate form inputs for deployments, catalog items, and resources.

Instructions

Generate request form model for a given library schema. POST /form-service/api/forms/renderer/model

Input Schema

NameRequiredDescriptionDefault
bodyYesRequest body Also accepts: $ref, $data, $dynamicDefault.
formIdNoThe request form id, used to find a form from a provider
formTypeNoThe form type
sourceIdNoThe request source id
resourceIdNoResource id
sourceTypeNoThe request source type
deploymentIdNoDeployment id

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

C2.6/5.0
Behavior2/5

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

Annotations already declare readOnly=false, destructive=false, idempotent=false and openWorld=true, so the safety profile is covered. The description adds nothing beyond the endpoint path: it does not say whether the model generation persists server state (which is what would justify readOnly=false on a "generate" call), whether auth or a valid formId/provider is required, or how large/complex the schema input may be.

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?

Two short sentences with the purpose front-loaded and no padding. The endpoint-path sentence duplicates the annotation title and earns little, but nothing is bloated.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

This is a complex tool (7 parameters including a deeply nested recursive JsonSchema object, no output schema). The description never says what a "form model" contains or how it relates to the sibling fetch/generate tools, so an agent has no basis for interpreting the result or confirming it called the right endpoint.

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% across all 7 parameters, including the recursive JSON-schema body, so the schema carries the load and the baseline of 3 applies. The description mentions "a given library schema" but does not clarify the interaction between body, formId, formType, sourceId, resourceId, sourceType and deploymentId (e.g. which selector fields are mandatory in practice).

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

"Generate request form model for a given library schema" gives a verb and a resource, but "request form model" is domain jargon and the description never distinguishes this from the crowded set of form siblings (form_generate, form_generate_json_schema, form_get_json_object_schema, form_fetch_form, form_fetch_customized_form). An agent cannot tell from this text which of those to pick.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

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

No when-to-use statement, no prerequisites, and no named alternative. The second line is just an HTTP route, which restates the annotation title rather than telling the agent under what conditions this tool is the right choice.

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