Skip to main content
Glama

create_document_from_outline

Turn a Markdown outline into a complete freeform canvas document with a cover, section pages, an optional ending, and tables, using a selected template.

Instructions

按 Markdown 大纲生成一整套自由画布卡片(v44):封面 + 每个 "## 小节" 一页 + 可选结尾页,风格沿用所选模板;小节里的 Markdown 表格也变成这一页的表格元素。大纲的完整语法(小节、要点、引文、表格、结尾页)见 get_guide("outline")。生成后建议先 check_document,再 render_document 看缩略图。

Input Schema

NameRequiredDescriptionDefault
outlineYesMarkdown 大纲:# 总标题 + 若干 ## 小节(小节下正文行填入该页正文)
templateIdYeslist_templates 返回的自由画布模板 id,如 "editorial-freeform"
includeDocumentNo同时返回完整文档 JSON(默认只返回 documentId 和 version)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.9/5.0
Behavior3/5

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

No annotations, so the description carries the full burden. It usefully discloses that Markdown tables become table elements on the page, that styling follows the chosen template, and that only documentId+version are returned by default. It never states that this is a write operation with persistent side effects, nor any permission or quota constraints — a notable gap for an unannotated mutation tool.

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?

One dense paragraph that front-loads what gets generated and follows with the syntax pointer and verification workflow. Every clause does work, though the parenthetical version tag and nested quoting make it slightly heavier than necessary.

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?

With no output schema and only three well-documented parameters, the description covers generation semantics, the syntax reference, and a validation path. The main missing piece is explicit disclosure of mutation side effects, which no annotation supplies.

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 the baseline is 3. The description adds context for outline (section/table/ending-page semantics) and template selection, but the concrete semantics of includeDocument and the expected id format come from the schema.

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+resource: generates a full set of freeform canvas cards from a Markdown outline, with the exact page mapping (cover + one page per '##' section + optional ending page). That page-structure detail distinguishes it from content-, HTML-, and template-based siblings without needing to name them.

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 workflow: consult get_guide("outline") for the full syntax, then check_document, then render_document for thumbnails. It doesn't explicitly exclude the content/HTML/template alternatives, so the when-not-to-use case is left implicit.

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