Skip to main content
Glama

create_document_from_template

Instantiate an editable document from a template ID, returning a document ID and page metadata for freeform canvases or a render-ready envelope for Markdown templates.

Instructions

按模板 id 实例化一份完整的可编辑文档:自由画布模板保存在服务端,返回 documentId(之后传给 inspect_document / apply_actions / check_document / render_document 等)和各页 id、名称;Markdown 模板返回 { source, platformId, themeId, fontFamily, radius, profile, images? } 信封(可用 render_markdown 无头渲染)。

Input Schema

NameRequiredDescriptionDefault
templateIdYeslist_templates 返回的模板 id,如 "editorial-freeform"
includeDocumentNo同时返回完整文档 JSON(默认只返回 documentId 和 version)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.8/5.0
Behavior4/5

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

With no annotations, the description does real work: it discloses that freeform templates are stored server-side and return a documentId plus per-page ids/names, while Markdown templates return a render envelope with images and can be headlessly rendered via render_markdown. It omits side effects such as permissions, quota, or whether the new document is shared by default.

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?

A single dense sentence that front-loads the core action and then branches into the two return shapes; every clause carries information. It is packed to the edge of readability but has 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?

No output schema exists, and the description compensates by spelling out the two distinct return payloads and which downstream tool consumes each, so an agent knows what it will get back in either case. For a 2-parameter creation tool this is essentially everything needed to call it correctly.

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%, so both templateId and includeDocument are already documented in the schema, and the description adds only the template-source hint already present in the schema text. It never mentions includeDocument or what its default suppression of the full JSON means in practice, so it adds little beyond structured fields.

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?

States a specific verb and resource: 'instantiate a complete editable document from a template id', and immediately splits the behavior by template family (freeform vs Markdown). It does not compare itself to create_document_from_content or create_document_from_html, so an agent must infer why it would pick a template over raw content.

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?

Implied usage is clear: you need a templateId obtained from list_templates, and the output feeds inspect_document / apply_actions / check_document / render_document. However, there is no explicit when-to-use-vs-alternatives statement, so the boundary with the other create_* siblings is left to inference.

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