Skip to main content
Glama
formfeed-dev

formfeed

Official

Get the data schema of a template

get_template_schema
Read-only

Retrieve the JSON Schema and sample data a template expects before rendering or validation. Use after listing templates to build compatible data; unknown slugs return an error.

Instructions

Returns the JSON Schema of the data object a template expects and the sample data it was designed with, from its published version, else its latest draft. Call it after list_templates and before render or validate_template, to build data that fits; ad-hoc html has no stored schema to read. When the template stores no schema, one is inferred from the sample data: treat that as a guide, not a contract. Read-only and free; an unknown slug returns an error.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
templateYesSlug (e.g. invoice) or tpl_ id, as list_templates returns them

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.3.10
    • changedInput schema / properties / template / description
      Previous value: -"Template slug or tpl_ id"New value: +"Slug (e.g. invoice) or tpl_ id, as list_templates returns them"
  2. First observedv0.3.7

TDQS

A4.7/5.0
Behavior5/5

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

Annotations already declare readOnlyHint and destructiveHint, but the description adds valuable context: it is free, returns an error for unknown slugs, and explains that inferred schemas are a guide not a contract. This goes beyond the structured metadata and helps the agent anticipate edge cases.

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?

The description is compact, front-loads the core purpose, and every sentence adds meaningful information. It covers return content, workflow, caveats, and error behavior without redundancy or fluff.

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 read-only tool with one parameter and no output schema, the description fully covers what an agent needs: what it returns, which version is used, when to call it, the inference caveat, and error behavior. Nothing essential 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 coverage is 100% and the parameter description in the schema is sufficient ('Slug (e.g. invoice) or tpl_ id, as list_templates returns them'). The description adds no additional parameter-level detail, so it neither enhances nor detracts from the schema. Baseline 3 is appropriate.

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?

The description clearly states the tool returns the JSON Schema and sample data for a template's `data` object, specifying the resource and action. It distinguishes itself from siblings by placing it in the workflow (after list_templates, before render/validate_template) and noting ad-hoc html lacks a stored schema, making it unambiguous which tool 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 Guidelines5/5

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

Explicitly instructs when to call it ('after list_templates and before render or validate_template') and provides a negative case (ad-hoc html has no stored schema). It also explains the fallback inference behavior, giving the agent clear decision criteria without needing to infer usage.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.