Skip to main content
Glama

vault_write

Write content to a project vault: append or replace sections, or create new files with auto-generated frontmatter. Supports multi-mode updates for Obsidian-based knowledge management.

Instructions

Write to the vault: append, replace a section, or create a new file.

Modes:

  • append/replace: Update a project section. Requires section.

  • create: Create a new file with auto-generated frontmatter. Requires path and doc_type.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
projectYesProject slug or '_meta' for cross-project content.
contentYesMarkdown content to write (body only for create mode).
operationNo'append', 'replace', or 'create'. Default 'append'.append
sectionNoSection shortcut (context, tasks, roadmap, lessons). For append/replace.
pathNoRelative path for new file. For create mode.
doc_typeNoDocument type for frontmatter. For create mode.
commitNoIf True (default), auto-commit to git. If False, write to disk but leave the file dirty so the caller can batch many writes into one commit via the ``vault_commit`` tool, or let obsidian-git's auto-commit pick it up. Durability contract: files are persisted to disk regardless; only the *commit* is deferred. A crash before the next flush loses the commit, not the file content.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior5/5

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

The description explains the commit behavior in detail (auto-commit vs. deferring commit via commit=false), including durability contract. This goes beyond annotations, which only indicate readOnly=false, destructiveHint=false.

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?

The description is concise, using bullet points for modes, and front-loaded with the core action. Every sentence adds value without redundancy.

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?

Given the tool's complexity (7 parameters, output schema), the description covers all modes, required parameters per mode, and commit behavior. It does not need to explain return values as 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. The description adds meaning by grouping parameters under modes ('Requires section for append/replace', 'Requires path and doc_type for create'), clarifying when each parameter is needed.

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 starts with 'Write to the vault: append, replace a section, or create a new file,' clearly stating the verb and resource. It differentiates from siblings like vault_commit, vault_list, etc., by focusing on writing content.

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

Usage Guidelines4/5

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

The description lists modes (append/replace, create) with required parameters, providing context for when to use each. It could explicitly say when not to use or compare with vault_patch, but the guidance is clear and helpful.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/mlorentedev/hive'

If you have feedback or need assistance with the MCP directory API, please join our Discord server