Markdown by mdedit.ai

Edit a Markdown Document

edit_article

DestructiveIdempotent

Apply anchored edits through mdedit's authoritative ordinary or collaborative document service. Edits can update an existing live public link or enabled publication sync. Accepts natural workspace names and document titles; internal routing identifiers are optional.

Input Schema

TableJSON Schema

Name	Required	Description
`context`	Yes	Describe the user's underlying goal in one sentence. Do not include private document content, credentials, or personal information.
`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 document edit. Generate it once and reuse the exact value if the tool call is retried.
`operations`	Yes
`workspaceId`	No	Optional workspace ID to narrow document lookup. Omit when the document title or ID uniquely identifies a document across authorized workspaces.
`articleTitle`	No	Human-visible document title. Prefer this over asking the user for an internal document identifier.
`ifContentHash`	No
`workspaceName`	No	Optional workspace name to narrow document lookup. A unique document title can be used without a workspace choice.

Output Schema

TableJSON Schema

Name	Required	Description	Default
`mode`	Yes
`result`	Yes
`content`	Yes
`articleId`	Yes
`contentHash`	Yes
`workspaceId`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

Changed5 schema fields changedOct 10, 2026

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",
-  "operations"
-]New value: +[
+  "commandId",
+  "operations",
+  "context"
+]

Changed8 schema fields changedSep 15, 2026

addedInput schema / properties / commandId

Added value: +{
+  "description": "Globally unique UUID for this logical document edit. 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"
+}

addedInput schema / properties / operations / maxItems
```
Added value: +100
```

changedInput schema / required

Previous value: -[
-  "operations"
-]New value: +[
+  "commandId",
+  "operations"
+]

addedOutput schema / properties / result / properties / applied / items / properties / deletedLength
```
Added value: +{
+  "maximum": 9007199254740991,
+  "minimum": 0,
+  "type": "integer"
+}
```
removedOutput schema / properties / result / properties / applied / items / properties / deletedText
```
Removed value: -{
-  "type": "string"
-}
```
addedOutput schema / properties / result / properties / applied / items / properties / insertedLength
```
Added value: +{
+  "maximum": 9007199254740991,
+  "minimum": 0,
+  "type": "integer"
+}
```
removedOutput schema / properties / result / properties / applied / items / properties / insertedText
```
Removed value: -{
-  "type": "string"
-}
```

changedOutput schema / properties / result / properties / applied / items / required

Previous value: -[
-  "operationIndex",
-  "type",
-  "range",
-  "deletedText",
-  "insertedText"
-]New value: +[
+  "operationIndex",
+  "type",
+  "range",
+  "deletedLength",
+  "insertedLength"
+]

First observedAug 28, 2026

TDQS

B3.4/5.0

Behavior3/5

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

Annotations declare destructiveHint=true, idempotentHint=true, and openWorldHint=true, so the description doesn't need to repeat safety traits. It adds value by noting that edits can affect live public links or publication sync, which is important behavioral context. However, it omits critical details like what gets destroyed, whether auth/permissions are required, or how errors/conflicts are handled, leaving significant gaps for a destructive operation.

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?

The description is two concise sentences that front-load the core action and scope. It is efficient but could be slightly more structured by separating behavioral constraints from usage hints.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (8 params, destructive, open-world) and the presence of an output schema, the description is somewhat complete but fails to address key behavioral aspects like permission requirements, error handling, or the implications of destructive edits on live links. It provides basic context but not enough for an agent to fully understand the operation's impact.

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 description coverage is 75%, so most parameters are documented. The description adds a bit by mentioning 'natural workspace names and document titles' and that internal routing identifiers are optional, which aligns with the schema's notes on articleId and workspaceName. But it doesn't clarify the 'operations' structure, 'commandId' usage, or 'ifContentHash', leaving some semantic gaps.

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 ('Apply anchored edits') and resource ('Markdown Document' via title), and clarifies scope related to live public links and publication sync. It is fairly clear, though the phrase 'mdedit's authoritative ordinary or collaborative document service' is somewhat jargon-heavy and doesn't sharply differentiate from sibling 'save_article_content'.

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?

The description implies usage for anchored edits but does not explicitly state when to choose this tool over alternatives like save_article_content or add_suggestion, nor does it outline exclusions or prerequisites beyond mentioning link/sync updates.

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?