Skip to main content
Glama

create_doc

Create a Markdown or HTML document on a Miro board at specified coordinates, optionally within a frame, to display formatted content directly on the board.

Instructions

Create a doc format item on the board.

content_type is markdown or html. Docs cannot be edited via REST after creation — see replace_doc.

Input Schema

NameRequiredDescriptionDefault
xYes
yYes
contentYes
board_idYes
content_typeNomarkdown
parent_frame_idNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.3/5.0
Behavior3/5

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

With no annotations, the description carries the full behavioral burden. It usefully discloses the key immutability constraint after creation, but it omits other important behavior such as permissions, how x/y positioning works, or how parent_frame_id affects placement.

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 two short sentences, front-loaded with the action and followed by the two most important caveats. There is no wasted text.

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

Completeness3/5

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

For a creation tool with no annotations and a schema that has no parameter descriptions, the description covers the main action and the critical non-editable constraint. It is still incomplete on positioning parameters, parent-frame behavior, and alternatives among creation siblings, though the output schema reduces the need to describe return values.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description should explain the six parameters. It only restates content_type values that are already in the enum schema and says nothing about board_id, content, x, y, or parent_frame_id.

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 gives a specific verb and resource: 'Create a doc format item on the board.' It also points to replace_doc for editing, which helps separate creation from replacement. However, it does not distinguish this creation path from sibling creation tools such as create_document_from_url or upload_document.

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?

The note 'Docs cannot be edited via REST after creation — see replace_doc' gives a clear edit-time alternative, implying create_doc is for initial creation and replace_doc for later changes. But it does not state when to use this tool versus create_document_from_url, upload_document, or other creation siblings.

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