Skip to main content
Glama

form_get_forms_versions_by_id

Read-onlyIdempotent

Retrieves a specific form definition version by UUID, letting you inspect the exact form configuration for automation or troubleshooting.

Instructions

Get form definition version by id GET /form-service/api/forms/versions/{id}

Input Schema

NameRequiredDescriptionDefault
idYesForm definition version identifier (path)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false and openWorldHint=true, so the safety profile is covered. The description adds nothing beyond restating the endpoint path – no error behavior or notes on what a 'version' represents.

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 lines, front-loaded with the verb and resource. The trailing endpoint path largely duplicates the annotation title, which is mild redundancy but not harmful.

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?

For a low-complexity, single-parameter read tool with full annotation coverage and full schema coverage, the description is sufficient to call it correctly. The absence of an output schema means return contents are undisclosed, which is a minor gap.

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 coverage is 100% and the id parameter is fully documented as a UUID path identifier, so the schema does the heavy lifting. The description contributes no additional meaning about the parameter.

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

Purpose4/5

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

The description states a specific verb and resource ('Get form definition version by id'), which is clearly a single-version retrieval distinct from the sibling listing tool form_get_forms_versions. It does not explicitly name that sibling, so it falls short of the top bar.

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

Usage Guidelines3/5

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

Usage is only implied: an agent can infer this is for fetching one known version, but the description gives no explicit when-to-use, no exclusions, and no pointer to form_get_forms_versions for enumeration.

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