Skip to main content
Glama
yenchieh

DiagramZu

by yenchieh
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

create_page

Create a Markdown page in the workspace — a design write-up, a decision record, a runbook, the prose a diagram cannot carry.

Instructions

Create a Markdown page in the workspace — a design write-up, a decision record, a runbook, the prose a diagram cannot carry. The title comes from the body (front-matter title, else the first top-level # heading), so begin the body with a heading rather than passing title. Embed a stored diagram by putting its id inside a fenced diagramzu block; an inline mermaid block is for a throwaway sketch nobody will revisit. Returns the page's id, its revision and its URL in the app, which only members of this workspace can open. To let somebody outside the workspace read it, a person in the workspace opens the page in DiagramZu and uses its Share button, which mints a public read-only link.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyYesThe page's Markdown (≤100,000 chars, counted after line endings and Unicode are normalised — i.e. of the text you would read back).
langNoOptional language tag for the page's prose — en, ja, zh-TW, pt-BR. Letters and hyphens only. Omit to inherit front-matter `lang`, else your account's language.
spaceNoWhich workspace to act in: its id, its slug, or its exact name (case-insensitive). Omit to use this token's default workspace. Call list_spaces to see what this token can reach. A name that matches more than one workspace is refused — pass the id or slug instead.
titleNoOptional display name (≤200 chars). The BODY wins: front-matter `title` or a leading `#` heading overrides this, which is why writing the heading is the better habit.
folderIdNoOptional UUID of an existing folder to put the page in. Use list_folders to find one by name. Omit to place it at the workspace root.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.0.8

TDQS

A4.4/5.0
Behavior4/5

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

With no annotations, the description carries the whole burden and does well: it explains title derivation precedence, states the return payload (id, revision, URL), discloses the visibility model ('only members of this workspace can open'), and notes that public sharing is a manual UI action rather than something this tool does. It omits who is permitted to create pages and any error/rejection behavior, so it is strong but not exhaustive.

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?

Four sentences, front-loaded with purpose and then ordered body-conventions, return value, and sharing. Mostly earn their place, though 'the prose a diagram cannot carry' and the extended Share-button walkthrough are more flavorful than strictly load-bearing.

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, yet the description names what comes back (id, revision, app URL), covers access visibility and the path to public sharing, and the 5-parameter schema is fully described. An agent has everything needed to construct a valid call and interpret the result.

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

Parameters4/5

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

Schema coverage is 100%, so 3 is the floor, and the description clears it by adding body-content semantics the schema does not: the `diagramzu` fenced-block syntax for embeddings and the `mermaid` convention. The title/body precedence it restates is already spelled out in the schema, so it only earns partial credit above baseline.

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?

Opens with a specific verb+resource ('Create a Markdown page in the workspace') and immediately characterizes the content ('a design write-up, a decision record, a runbook, the prose a diagram cannot carry'), which separates it from create_diagram and create_deck. An agent can identify the tool without opening the schema.

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 concrete when-to guidance: put the title in the body rather than the title field, use a fenced `diagramzu` block to embed a stored diagram versus an inline `mermaid` block for a throwaway sketch, and route to the in-app Share button for external readers. It never explicitly contrasts create_page against sibling create_diagram, so it stops short of a full when/when-not matrix.

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