Skip to main content
Glama

Publish a Markdown Document

publish_article
DestructiveIdempotent

Publish or update a Markdown Document at a public mded.it link. Accepts natural workspace names and document titles; internal routing identifiers are optional. New links default to live. Later durable edits automatically update a live link at the same URL. Choose snapshot for a frozen artifact. Existing links keep their stored mode unless mode is supplied. Requires publishing:write and explicit user confirmation.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
modeNoChoose live for a link that follows later durable edits, or a frozen snapshot for a fixed artifact. Omit this only to preserve an existing link mode; new links default to live.
contextYesDescribe the user's underlying goal in one sentence. Do not include private document content, credentials, or personal information.
articleIdNoInternal document identifier when already available. Omit it when the user referred to the document by title.
commandIdYesGlobally unique UUID for this logical publishing mutation. Generate it once and reuse the exact value if the tool call is retried.
customSlugNo
seoMetadataNo
workspaceIdNoOptional workspace ID to narrow document lookup. Omit when the document title or ID uniquely identifies a document across authorized workspaces.
articleTitleNoHuman-visible document title. Prefer this over asking the user for an internal document identifier.
confirmPublicYesMust be true after the user confirms that anyone with the link may view the document.
workspaceNameNoOptional workspace name to narrow document lookup. A unique document title can be used without a workspace choice.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
modeYes
fullUrlYes
shortUrlYes
articleIdYes
publishIdYes
syncStatusYes
publishedAtYes
workspaceIdYes
sourceVersionIdNo
sourceContentHashNo
lastSuccessfulSyncAtNo
sourceArticleRevisionNo
sourceContentRevisionNo
sourcePackageRevisionNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changed
    • removedInput schema / additionalProperties
      Removed value: -false
    • addedInput schema / properties / context
      Added value: +{
      +  "description": "Describe the user's underlying goal in one sentence. Do not include private document content, credentials, or personal information.",
      +  "type": "string"
      +}
    • changedInput schema / properties / workspaceId / description
      Previous value: -"Internal workspace identifier when already available. Omit it when the user referred to a workspace by name or has only one workspace."New value: +"Optional workspace ID to narrow document lookup. Omit when the document title or ID uniquely identifies a document across authorized workspaces."
    • changedInput schema / properties / workspaceName / description
      Previous value: -"Human-visible workspace name. Prefer this over asking the user for an internal workspace identifier."New value: +"Optional workspace name to narrow document lookup. A unique document title can be used without a workspace choice."
    • changedInput schema / required
      Previous value: -[
      -  "commandId",
      -  "confirmPublic"
      -]New value: +[
      +  "commandId",
      +  "confirmPublic",
      +  "context"
      +]
  2. Changed2 schema fields changed
    • addedInput schema / properties / commandId
      Added value: +{
      +  "description": "Globally unique UUID for this logical publishing mutation. Generate it once and reuse the exact value if the tool call is retried.",
      +  "format": "uuid",
      +  "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      +  "type": "string"
      +}
    • changedInput schema / required
      Previous value: -[
      -  "confirmPublic"
      -]New value: +[
      +  "commandId",
      +  "confirmPublic"
      +]
  3. First observed

TDQS

A4.2/5.0
Behavior5/5

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

Annotations already declare destructive/openWorld/idempotent, but the description adds genuinely new behavioral facts: the required scope (publishing:write), the need for explicit user confirmation, and the key trait that later durable edits update a live link at the same URL. This is meaningful disclosure beyond the structured hints.

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 purpose, then mode semantics, then permission requirements, with no filler. Every sentence carries information, though the mode explanation partly restates the mode schema description, making it slightly denser 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?

For a 10-parameter mutation with a nested seoMetadata object and an output schema, the description covers the critical behavioral and permission surface well. Return values are handled by the output schema, so the remaining gaps are only the uncovered customSlug and seoMetadata semantics.

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 80%, so the baseline is 3, and the description adds real value: it explains that workspace names and document titles are accepted with internal routing identifiers optional, mapping directly onto articleTitle/articleId/workspaceName behavior. It omits customSlug and the seoMetadata object entirely, so not all uncovered parameters are compensated.

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+resource ('Publish or update a Markdown Document at a public mded.it link') and specifies the artifact type and target surface. It is clearly distinct from unpublish_article and get_publish_status in intent, but never names or contrasts with those siblings, so it sits just below the top bar.

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 real selection guidance for the mode parameter ('New links default to live', 'Choose snapshot for a frozen artifact', 'Existing links keep their stored mode unless mode is supplied') and states prerequisites (publishing:write, explicit user confirmation). It does not, however, address when to reach for publish vs unpublish or check status.

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.

Resources