Markdown by mdedit.ai

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

Name	Required	Description
`mode`	No	Choose 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.
`articleId`	No	Internal document identifier when already available. Omit it when the user referred to the document by title.
`commandId`	Yes	Globally unique UUID for this logical publishing mutation. Generate it once and reuse the exact value if the tool call is retried.
`customSlug`	No
`seoMetadata`	No
`workspaceId`	No	Internal workspace identifier when already available. Omit it when the user referred to a workspace by name or has only one workspace.
`articleTitle`	No	Human-visible document title. Prefer this over asking the user for an internal document identifier.
`confirmPublic`	Yes	Must be true after the user confirms that anyone with the link may view the document.
`workspaceName`	No	Human-visible workspace name. Prefer this over asking the user for an internal workspace identifier.

Output Schema

TableJSON Schema

Name	Required	Description	Default
`mode`	Yes
`fullUrl`	Yes
`shortUrl`	Yes
`articleId`	Yes
`publishId`	Yes
`syncStatus`	Yes
`publishedAt`	Yes
`workspaceId`	Yes
`sourceVersionId`	No
`sourceContentHash`	No
`lastSuccessfulSyncAt`	No
`sourceArticleRevision`	No
`sourceContentRevision`	No
`sourcePackageRevision`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed2 schema fields changedSep 15, 2026

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"
+]

First observedAug 28, 2026

TDQS

A4.7/5.0

Behavior5/5

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

Beyond the annotations, it discloses that later durable edits automatically update a live link at the same URL, that snapshot mode freezes an artifact, that existing links keep their mode unless overridden, and that user confirmation is required. These are meaningful behavioral traits not carried by readOnlyHint/idempotentHint/destructiveHint.

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?

Five tight sentences front-load the core purpose and then add only high-value behavioral and permission details. No filler or repetition.

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?

Given nine parameters, nested objects, and an output schema, the description plus schema covers permissions, confirmation, mode selection, identifier strategy, and idempotency. An agent has enough to call this correctly without hunting for missing context.

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?

With 78% schema description coverage, the schema already documents most parameters. The description adds a compact conceptual layer—natural names vs optional internal routing identifiers and live vs snapshot mode behavior—that helps an agent pick the right fields, though it does not elaborate customSlug or seoMetadata.

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?

The description opens with 'Publish or update a Markdown Document at a public mded.it link', which names a specific verb, resource, and destination. It also clarifies that natural workspace names and document titles are accepted, distinguishing the routing style from ID-only tools.

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?

It gives clear context for invocation: natural names are preferred, internal IDs are optional, new links default to live, and publishing:write plus explicit user confirmation are required. It does not name sibling tools or state when not to use it, so it stops short of a 5.

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

All Markdown by mdedit.ai tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?