vault | string | | — | Vault id. May be omitted when only one vault is available. length 1–64; pattern ^[a-z0-9_-]+$ |
path | string | yes | — | length 1–1024 |
operation | enum | yes | — | Which edit to make. append, prepend and replace take content and need an anchor or target_heading; replace_text takes old_string and new_string and needs neither. Each field’s description says which operations require or refuse it. One of: "append", "prepend", "replace", "replace_text" |
target_heading | string | | — | Legacy shorthand for anchor:{type:“heading”,heading}. append, prepend and replace need anchor or target_heading; replace_text needs neither (with neither it is note-wide). length ≥ 1 |
anchor | object | | — | Where to act: {type:“heading”,heading:“Notes”[,occurrence:2]}, {type:“block”,block_id:“abc”} or {type:“frontmatter”} (the preamble above the first heading). append, prepend and replace need anchor or target_heading; replace_text needs neither: with neither it matches over the whole note body (frontmatter excluded, heading lines included). |
anchor.type | enum | with parent | — | One of: "heading", "block", "frontmatter" |
anchor.heading | string | | — | Heading text without the # marks, e.g. “Notes”; case-insensitive. To pick one of several same-named headings by its parents write “Parent > Child” (outermost first). length ≥ 1 |
anchor.occurrence | integer | | — | 1-based index among the headings that match, in document order. Needed when the heading appears more than once and no Parent > Child path singles it out; otherwise the call is refused with every match’s line number. range ≥ 1 |
anchor.block_id | string | | — | length ≥ 1 |
content | string | | — | Required for append, prepend and replace; refused for replace_text. |
insert_before | string | | — | Optional for append only: insert content immediately above the unique line matching this value within the resolved section, ignoring trailing spaces and tabs. Fenced code and a heading anchor’s own heading line are excluded. |
old_string | string | | — | Required for replace_text, refused for append, prepend and replace: the exact text to find inside the anchor’s section, or inside the whole note body when there is no anchor; it must occur exactly once. To move or reorder sections, anchor on an enclosing heading and put the whole span here. length ≥ 1 |
new_string | string | | — | Required for replace_text, refused for append, prepend and replace: the text that takes old_string’s place (may be empty to delete). |
prev_hash | string | | — | — |
options | object | | {} | — |
options.idempotency_key | string | | — | length 1–128 |
options.create_dirs | boolean | | true | — |
confirm_replace | boolean | | false | — |
response_format | enum | | — | concise returns only the high-signal fields; detailed (the shipped default) returns the full payload. Errors and safety warnings are never trimmed. When omitted, the server’s tools.defaults.responseFormat applies. One of: "concise", "detailed" |
verbosity | enum | | — | Legacy alias for response_format: terse = concise, full = detailed. One of: "full", "terse" |