Skip to main content
Glama

postmd_create_document

Publish Markdown as a PostMD web page. No API key required — anyone can publish. Returns docCode and data.shareUrl; hand shareUrl to people. Documents have a 30-day retention period (data.retainedUntil) that extends on each read. Documents without a password can be updated or deleted by anyone; password-protected documents require the password or the owner's API key. With an API key the document belongs to that member; groupId files it into that group (key with documents:write). The returned docCode can be kept at the top of the source file in a postmd:document comment (format at /docs/api) so a later session finds the document.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
titleNoShown in the viewer and link previews. Defaults to fileName without .md.
groupIdNoFile the document in this group instead of the default group (needs an API key).
fileNameNoUpload filename, must end in .md. Default document.md.
markdownYesFull Markdown document as one UTF-8 string (the entire source, not a summary). May include graph data in an HTML comment, which the viewer draws; the format is at /docs/graph.
passwordNoReaders must supply this password to see the content.
viewerStyleNoViewer theme: readable (default), github, minimal, report, pamphlet or dark. Unknown values fall back to readable.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / markdown / description
      Previous value: -"Full Markdown document as one UTF-8 string (the entire source, not a summary). May include graph data in an HTML comment, which the viewer draws beside the text; the format is at /docs/graph."New value: +"Full Markdown document as one UTF-8 string (the entire source, not a summary). May include graph data in an HTML comment, which the viewer draws; the format is at /docs/graph."
  2. Changed1 schema field changed
    • changedInput schema / properties / markdown / description
      Previous value: -"Full Markdown document as one UTF-8 string (the entire source, not a summary)."New value: +"Full Markdown document as one UTF-8 string (the entire source, not a summary). May include graph data in an HTML comment, which the viewer draws beside the text; the format is at /docs/graph."
  3. First observed

TDQS

A4.4/5.0
Behavior5/5

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

Annotations carry almost nothing (only destructiveHint=false), so the description does the heavy lifting and does it well: 30-day retention extending on each read, that passwordless documents can be updated/deleted by anyone, that password-protected ones need the password or owner API key, and the documents:write scope requirement. These are consequential side effects an agent must know before publishing.

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?

Purpose is front-loaded in the first sentence, and the remaining sentences each carry distinct operational facts (return fields, retention, permissions, docCode convention). It is dense and somewhat long, but nearly every clause earns its place.

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?

With no output schema, the description correctly supplies the return contract (docCode, data.shareUrl, data.retainedUntil) and explains retention, ownership, and the docCode-in-source-file convention. An agent has everything needed to publish and later re-locate the document.

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 — each parameter is already documented in the schema, including title defaults, fileName extension requirement, password behavior, and viewerStyle fallback. The description mostly reinforces permission semantics already present in the schema (groupId needs an API key) rather than adding new parameter-level meaning.

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 and resource — 'Publish Markdown as a PostMD web page' — which is unambiguous and cleanly separable from the sibling get/update/delete operations. An agent can identify the create action 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 clear conditions: no API key needed for anonymous publishing, API key makes the document belong to a member, and groupId files it into a group (needing documents:write). It stops short of explicitly naming alternatives such as postmd_update_document for later edits, but the auth/no-auth and ownership branches give strong context.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.