Skip to main content
Glama

postmd-mcp-server

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).

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 beside the text; 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)."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."
  2. First observed

TDQS

A4.1/5.0
Behavior5/5

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

Goes well beyond the thin annotations (destructiveHint=false, title). It discloses auth model (no key required, key for ownership), retention (30-day, extended on read, data.retainedUntil), mutation semantics for passwordless vs password-protected docs, required scope for groupId, and the return fields. This is exactly the behavioral context an agent needs.

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?

Front-loads the core purpose, then layers behavior in a tight sequence. It is dense but every clause (retention, shareUrl, ownership) carries information; only the 'anyone can publish' framing is mildly redundant with the surrounding sentences.

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 and no rich annotations, the description carries the full burden and does so: it names the return values (docCode, data.shareUrl, data.retainedUntil), explains sharing, retention, ownership, and permission requirements. Nothing essential to correct invocation is missing.

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 already 100%, so the baseline is 3, but the description adds real meaning: groupId's requirement of an API key and the documents:write scope, plus the password/ownership implications that the schema only gestures at ('Readers must supply this password').

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: publish Markdown as a PostMD web page. It is clearly distinguishable from the get/delete siblings in intent, though it never explicitly contrasts itself with postmd_update_document or the other siblings by name.

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?

Usage conditions are implied and partially spelled out (no API key required, API key for ownership, groupId for filing), but there is no explicit statement of when to choose this tool over update_document or the getters. An agent must infer the create-vs-modify boundary.

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.