Skip to main content
Glama

Edit Doc content

edit_doc_content
Destructive

Apply targeted Markdown edits to a doc after reading its current content. Prefer exact text or block edits; preserve unrelated content. Full rewrites and large removals are checked by the collaborative editor. Set allowRemoval only for a user-requested removal. Re-read after a conflict; never blindly retry. Preserve requestId on retries.

Input Schema

NameRequiredDescriptionDefault
idYesExisting target ID returned by the matching list, read or search tool. Preserve any search type prefix. Do not invent IDs.
editsYes1–20 targeted edits, at most 50,000 characters total.
requestIdYesA unique UUID for this intended action. Reuse it unchanged when retrying the same action.
allowRemovalNoTrue only when the user explicitly requested the removal of existing content.

Output Schema

NameRequiredDescriptionDefault
editYesEdworking record fields permitted for this connection.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already declare destructiveHint=true and idempotentHint=false, and the description adds the context behind that: edits are validated by a collaborative editor, large removals require the allowRemoval flag, and retries must be idempotent via a preserved requestId. This is exactly the operational detail the booleans cannot convey.

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?

Four short sentences, purpose first, then editing strategy, then the two cautionary behaviors. No filler, no restatement of the title, and each clause carries an actionable instruction.

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?

With an output schema present and rich per-field, per-enum descriptions in the schema, the description only needed to cover workflow semantics — preconditions, edit strategy, removal gating, and conflict recovery — all of which it does. Nothing material for correct invocation is missing.

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 100%, so the baseline is 3; the description goes further by explaining why allowRemoval exists (the editor checks large removals) and tying requestId to the retry-after-conflict workflow. It restates some schema content, but the gating rationale and retry contract add real meaning.

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 opens with a precise verb+resource+mode: 'Apply targeted Markdown edits to a doc after reading its current content,' and the emphasis on targeted edits implicitly separates it from the coarser update_doc sibling. It never names update_doc outright, so an agent must still infer which of the two doc-mutation siblings to pick in edge cases.

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

Usage Guidelines5/5

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

It gives the prerequisite (read the doc first), the preferred mode (exact text or block edits), the discouraged mode (full rewrites and large removals, which the collaborative editor inspects), and an explicit gating condition for allowRemoval. Conflict handling is also spelled out: re-read, do not blindly retry, keep requestId on retries.

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.