Skip to main content
Glama

Edit a Markdown Document

edit_article
Destructive

Apply anchored edits to a Markdown Document through a persistent live session when collaboration is enabled. 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.
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. Dates show when Glama detected each change.

  1. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already convey that the tool is destructive and not read-only, and the description adds useful behavioral context: this is not a one-shot edit but one that occurs through a persistent live session, implying statefulness and possible side effects beyond the single call. It does not contradict the annotations and adds meaningful non-schema information.

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?

Two tight sentences deliver the core action, the session-based behavior, and the key routing guidance without wasted words. The most important behavioral information is front-loaded before the parameter-preference note.

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 — multiple operation types, rich anchor forms, and a destructive annotation — the description is functional for selection but thin on operational context. It does not clarify the lifecycle of the live session, the role of ifContentHash, or what happens if collaboration is not enabled; the rich schema and output schema carry much of the load.

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?

The schema already documents four of six parameters, and the description reinforces the routing guidance by saying natural workspace names and document titles are accepted while internal identifiers are optional. However, it does not explain the purpose of ifContentHash or add much beyond the existing parameter descriptions; the complex operations structure is left entirely to the schema.

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 names a specific verb ('Apply... edits'), a specific resource ('Markdown Document'), and a distinguishing method ('anchored edits') and context ('persistent live session when collaboration is enabled'). This makes it clear that the tool is for directly modifying an existing document rather than merely suggesting, commenting, converting, or publishing it.

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 gives a usage condition by saying edits happen 'through a persistent live session when collaboration is enabled', which helps an agent identify the enabling environment. However, it does not state when to prefer this tool over siblings like add_suggestion, convert_document, or create_article, nor does it explain what to do when collaboration is not enabled.

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.

TDQS

A3.6/5.0
Disambiguation4/5

Most tools have clearly distinct purposes across article CRUD, review workflows, publishing, and conversion/export. Minor confusion can arise between convert_document and start_article_export (and their corresponding status checkers), but the descriptions explicitly differentiate arbitrary content conversion from exporting stored documents. The render_article tool's broad contextual wording overlaps conceptually with several actions, though its actual function (opening the reader) is unique.

Naming Consistency5/5

All 22 tool names follow a strict snake_case verb_noun pattern, such as list_articles, accept_suggestion, start_article_export, and unpublish_article. There are no mixed conventions, vague verbs, or camelCase outliers, making the naming highly predictable.

Tool Count3/5

At 22 tools, the server sits above the ideal 3-15 range and feels somewhat heavy for an MCP surface. The inclusion of record_article_app_event, a component-only telemetry tool with no agent-facing value, adds to this heaviness. However, the breadth of the domain—documents, collaboration, publishing, and conversion—largely justifies the count.

Completeness3/5

The tool surface covers article lifecycle, review threads, publishing, export/conversion, and presence well, covering most common workflows. A notable gap is the lack of any delete_article or trash operation, leaving no way to remove documents. Additionally, updates are limited to anchored edits via edit_article, with no direct full-content replacement option.

Resources