Skip to main content
Glama
wirux

mcp-markdown-vault

by wirux

Edit

edit

Modify markdown vault notes safely. Supports AST-based changes, line/string replacements, frontmatter updates, and batch operations with dry run preview.

Instructions

Edit notes safely. Vault scope: general markdown notes vault. Supports AST edits by heading/block ID, freeform line/string replacement, frontmatter_set metadata merges, batch operations (max 50), and dryRun=true unified diff previews. Read vault://overview for editing strategy and conventions.

TIPS: Always use dryRun=true before destructive operations (delete, replace). Use bulk_read for reading 2+ files. Use view.outline before heading-specific edits when unsure of heading names. string_replace requires exact literal match including whitespace/newlines.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathNoNote path (required for single edit).
dryRunNoIf true, returns a preview of changes as a unified diff without saving to disk.
blockIdNo
contentNoContent to apply (required for single edit, ignored for delete).
endLineNo
headingNo
operationNoEdit operation (required for single edit). 'delete' removes the full heading section including child headings. 'replace' by default replaces only the body under the heading (heading node preserved). Use replaceMode='section' to replace the heading and all its content.
startLineNo
operationsNoFor batch mode: array of edit operations (max 50). Executed sequentially, stops on first error.
replaceAllNo
searchTextNo
replaceModeNoFor replace operation: 'body' (default) preserves the heading node and replaces only body content. 'section' replaces the entire heading section including the heading node and all child headings.
headingDepthNo
returnContentNoWhen set to 'section' or 'file', the response includes the modified content (max 8KB). Defaults to 'none'.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed8 schema fields changedv2.3.1
    • changedInput schema / properties / content / description
      Previous value: -"Content to apply (required for single edit)."New value: +"Content to apply (required for single edit, ignored for delete)."
    • changedInput schema / properties / operation / description
      Previous value: -"Edit operation (required for single edit)."New value: +"Edit operation (required for single edit). 'delete' removes the full heading section including child headings. 'replace' by default replaces only the body under the heading (heading node preserved). Use replaceMode='section' to replace the heading and all its content."
    • changedInput schema / properties / operation / enum
      Previous value: -[
      -  "append",
      -  "prepend",
      -  "replace",
      -  "line_replace",
      -  "string_replace",
      -  "frontmatter_set"
      -]New value: +[
      +  "append",
      +  "prepend",
      +  "replace",
      +  "delete",
      +  "line_replace",
      +  "string_replace",
      +  "frontmatter_set"
      +]
    • changedInput schema / properties / operations / items / properties / operation / enum
      Previous value: -[
      -  "append",
      -  "prepend",
      -  "replace",
      -  "line_replace",
      -  "string_replace",
      -  "frontmatter_set"
      -]New value: +[
      +  "append",
      +  "prepend",
      +  "replace",
      +  "delete",
      +  "line_replace",
      +  "string_replace",
      +  "frontmatter_set"
      +]
    • addedInput schema / properties / operations / items / properties / replaceMode
      Added value: +{
      +  "enum": [
      +    "body",
      +    "section"
      +  ],
      +  "type": "string"
      +}
    • changedInput schema / properties / operations / items / required
      Previous value: -[
      -  "path",
      -  "operation",
      -  "content"
      -]New value: +[
      +  "path",
      +  "operation"
      +]
    • addedInput schema / properties / replaceMode
      Added value: +{
      +  "description": "For replace operation: 'body' (default) preserves the heading node and replaces only body content. 'section' replaces the entire heading section including the heading node and all child headings.",
      +  "enum": [
      +    "body",
      +    "section"
      +  ],
      +  "type": "string"
      +}
    • addedInput schema / properties / returnContent
      Added value: +{
      +  "description": "When set to 'section' or 'file', the response includes the modified content (max 8KB). Defaults to 'none'.",
      +  "enum": [
      +    "none",
      +    "section",
      +    "file"
      +  ],
      +  "type": "string"
      +}
  2. First observedv1.7.3

TDQS

A4/5.0
Behavior4/5

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

No annotations are provided, so the description carries the burden and mostly does: it discloses dryRun diff previews, the max-50 batch limit, and the exact-match requirement for string_replace. It stops short of stating permission/scope requirements or reversibility beyond dryRun, and some behavioral facts (delete removes the whole heading section) live in the schema rather than the description.

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?

Front-loads the core purpose ('Edit notes safely') followed by scope and capabilities, then a clearly delimited TIPS block. Efficient and scannable, though a few capability clauses (e.g. delete/replace semantics) restate what the schema already documents.

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?

For a 14-parameter mutation tool with no annotations, no output schema, and only 50% schema description coverage, the description covers purpose, safety, and batch constraints well but omits line-range editing, replaceAll, headingDepth, and returnContent behavior. Adequate but with clear gaps against the tool's complexity.

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 coverage is only 50%, so the description should compensate more than it does. It adds meaning for the operation families (AST vs. line/string replacement vs. frontmatter merge) but leaves replaceAll, headingDepth, startLine/endLine, and returnContent unaddressed, so several parameters remain undocumented in both schema and prose.

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 and resource ('Edit notes'), names the vault scope, and enumerates the concrete edit modes (AST by heading/block ID, line/string replacement, frontmatter_set, batch). An agent immediately knows this is the write tool. It does not explicitly contrast itself with the sibling tools (view, vault), so it falls short of the top score.

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?

The TIPS block gives explicit conditions and routes to alternatives: 'Always use dryRun=true before destructive operations', 'Use bulk_read for reading 2+ files', 'Use view.outline before heading-specific edits'. It also flags a hard prerequisite for one operation (string_replace requires exact literal match including whitespace/newlines), which is exactly the kind of pre-call guidance that prevents failures.

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

Deploy Server

Other Tools