Skip to main content
Glama
aliasunder

Vault Cortex Obsidian MCP Server

by aliasunder
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

Update Properties

vault_update_properties
DestructiveIdempotent

Update a note's frontmatter properties. By default they merge shallowly — new keys added, matching keys overwritten, null deletes a key, unmentioned keys preserved.

Instructions

Update a note's frontmatter properties. By default they merge shallowly — new keys added, matching keys overwritten, null deletes a key, unmentioned keys preserved. With replace: true they replace the whole properties block (null writes an empty property, {} removes it). A merge refuses a block it cannot keep — invalid YAML, a list, a single value, or a YAML tag — so replace is how to repair one. The body is kept; a merge only adds a missing final newline.

Example: vault_update_properties({ path: "Projects/todo.md", properties: { status: "active", draft: null } }) Example: vault_update_properties({ path: "Projects/todo.md", properties: { title: "Todo", status: "active" }, replace: true })

When to use: Changing tags, status, type, or any property without reading/rewriting the full note body. Prefer vault_write_note when creating a new note, or replacing the body (with overwrite: true). Read current properties first with vault_read_note({ properties_only: true }), or the full note when repairing a block. Arrays are replaced entirely, not appended to.

Errors:

  • "note not found" — path does not exist; create the note first with vault_write_note

  • "path must end in …" — add the .md extension

  • "absolute path blocked" / "path traversal blocked" / "hidden path blocked" — use a vault-relative path with no hidden (dot-prefixed) file or folder in it

  • "concurrent write in progress" — another write to this note is in flight; re-read the note and retry

  • "properties block …" — without replace: true, the note's properties block can't be read, or a rewrite would lose it; the error says how to repair it

  • "the note would open with a properties block …" — the edit would leave --- lines at the top of a note with no properties, around text that can't be kept as properties; the error says how to avoid it

Obsidian syntax: Use arrays for multi-value fields (tags: [a, b]), quote wikilinks ("[[Note]]"), keep types consistent (mismatches cause silent query failures).

Returns: "Updated properties on ", or "Replaced properties on " with replace: true.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesVault-relative path to the note, including the ".md" extension. Use the exact letter case.
replaceNoReplace instead of merging (default: false).
propertiesYesProperties to merge, or with replace the complete new set.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.54.13
    • changedInput schema / properties / properties / description
      Previous value: -"Properties to merge; a null value deletes that key."New value: +"Properties to merge, or with replace the complete new set."
    • addedInput schema / properties / replace
      Added value: +{
+  "default": false,
+  "description": "Replace instead of merging (default: false).",
+  "type": "boolean"
+}
  2. Changed1 schema field changedv0.54.9
    • changedInput schema / properties / properties / description
      Previous value: -"Properties to merge. New keys are added; existing keys are overwritten; a null value deletes that key; unmentioned keys are preserved."New value: +"Properties to merge; a null value deletes that key."
  3. Changed1 schema field changedv0.54.7
    • changedInput schema / properties / path / description
      Previous value: -"Vault-relative path to the note, including the \".md\" extension"New value: +"Vault-relative path to the note, including the \".md\" extension. Use the exact letter case."
  4. Addedv0.32.1
  5. Removedv0.32.0
  6. Changed1 schema field changedv0.23.10
    • changedInput schema / properties / path / description
      Previous value: -"Vault-relative path to the note"New value: +"Vault-relative path to the note, including the \".md\" extension"
  7. Changed1 schema field changedv0.15.23
    • changedInput schema / properties / properties / description
      Previous value: -"Properties to merge. New keys are added; existing keys are overwritten; unmentioned keys are preserved."New value: +"Properties to merge. New keys are added; existing keys are overwritten; a null value deletes that key; unmentioned keys are preserved."
  8. Added

TDQS

A4.8/5.0
Behavior5/5

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

Annotations cover safety flags (destructive, idempotent), but the description adds far more: exact merge semantics (null deletes, unmentioned keys preserved), replace-time behavior (null writes empty, {} removes), refusal conditions (invalid YAML, list, single value, tag), body preservation, and a per-error troubleshooting map. That is exceptional disclosure beyond the structured fields.

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 key semantic distinction (merge vs. replace), then examples, then when-to-use, then errors. Dense but every section earns its place. Slightly long, but not padded.

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?

Covers purpose, semantics, alternatives, examples, syntax guidance, and a comprehensive error table tailored to this tool's actual failure modes. Nothing material for correct invocation is missing, given no output schema exists.

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 baseline is 3, but the description adds real meaning: it explains null-deletes-a-key, that replace takes the complete new set, and that arrays are replaced not appended. The example calls ground the parameter usage without restating 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?

States a specific verb (update) and resource (a note's frontmatter properties) and distinguishes itself from siblings like vault_write_note and vault_patch_note. The merge vs. replace semantics are defined precisely enough that an agent knows exactly what this does.

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?

Explicit 'When to use' line names the scenario (changing tags/status/type without rewriting the body), names the preferred alternative for other cases (vault_write_note for creating or replacing the body), and prescribes reading first with vault_read_note({properties_only:true}).

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