Skip to main content
Glama

Edit a Markdown Document

edit_article
DestructiveIdempotent

Apply anchored edits through mdedit's authoritative ordinary or collaborative document service. Accepts natural workspace names and document titles; internal routing identifiers are optional.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
articleIdNoInternal document identifier when already available. Omit it when the user referred to the document by title.
commandIdYesGlobally unique UUID for this logical document edit. Generate it once and reuse the exact value if the tool call is retried.
operationsYes
workspaceIdNoInternal workspace identifier when already available. Omit it when the user referred to a workspace by name or has only one workspace.
articleTitleNoHuman-visible document title. Prefer this over asking the user for an internal document identifier.
ifContentHashNo
workspaceNameNoHuman-visible workspace name. Prefer this over asking the user for an internal workspace identifier.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
modeYes
resultYes
contentYes
articleIdYes
contentHashYes
workspaceIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed8 schema fields changed
    • 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"
      +]
  2. First observed

TDQS

B3.3/5.0
Behavior3/5

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

Annotations provide readOnlyHint=false, destructiveHint=true, and idempotentHint=true, covering safety and idempotency. The description adds 'apply anchored edits', which clarifies the method of modification beyond annotations, but does not describe side effects, failure modes, or concurrency behavior. Given the annotations cover the main behavioral concerns, a 3 is appropriate.

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?

Two sentences, with the key intent ('apply anchored edits') front-loaded. It is concise but not overly terse; it conveys the core behavior without wasting words. Some redundancy with the title is acceptable.

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 this is a complex edit tool with many operation types and the schema is extensive (71% coverage), the description alone is sparse. It doesn't mention how to construct operations, what the output represents (though output schema exists), or any error/rollback notes. The schema and output schema carry much of the burden, but the description could elaborate more on usage patterns. It's adequate but leaves gaps.

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?

The description clarifies that natural workspace names and document titles are preferred over internal identifiers, which adds meaning to parameters like workspaceName, articleTitle vs workspaceId, articleId. This is valuable beyond the schema's per-parameter descriptions, which are already detailed but don't explain the preference.

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?

The description clearly states the tool applies anchored edits to documents, which is a specific verb+resource. It also mentions the 'authoritative ordinary or collaborative document service', which hints at scope but is vague. It does not explicitly distinguish from sibling edit-like tools (e.g., add_suggestion, accept_suggestion), but the general purpose is clear.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives. It does not say 'use this to modify existing documents' or mention any exclusions. It only hints at parameter preferences (natural names vs IDs), but not tool selection 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.

Resources