Skip to main content
Glama

init_obsidian_vault

Initializes or syncs Obsidian vault configuration with preset color profiles for key tags like #decision and #lesson, optionally generating a graph index note to organize your PKM workspace.

Instructions

Initializes or syncs Obsidian PKM vault configuration (.obsidian/graph.json, app.json)
with preset color profiles for #decision, #lesson, #handoff, #context.

Args:
    workspace_dir: Workspace root directory.
    scope: Target scope ('local' or 'global').
    override_existing: Whether to overwrite existing .obsidian config files.
    export_index: Also generate dynamic _GRAPH_INDEX.md note.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "init_obsidian_vault"
  }
}

Input Schema

NameRequiredDescriptionDefault
scopeNolocal
export_indexNo
workspace_dirNo
override_existingNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.1.2

TDQS

B3.3/5.0
Behavior3/5

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

With no annotations, the description does carry useful side-effect disclosure: it writes .obsidian config files, can overwrite them when override_existing is set, and generates a _GRAPH_INDEX.md note. It does not say whether the operation is idempotent, what happens if the vault/directory doesn't exist, or whether unlisted existing settings are preserved.

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?

The purpose sentence is front-loaded and specific, followed by a compact Args block. The Args block slightly duplicates schema titles, but each line still adds meaning, so there is little waste.

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?

An output schema exists, so return values need not be explained. But for a write tool with zero annotations, the definition should say whether the vault must already exist, whether re-running is safe, and what 'sync' changes – none of which are covered.

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 0%, so the description must do the work, and it does: it enumerates the two allowed scope values ('local' or 'global'), explains override_existing as overwriting existing .obsidian config files, and clarifies that export_index produces the named _GRAPH_INDEX.md note. The gap is workspace_dir, whose empty-string default is never explained (cwd? required?).

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?

Names a specific verb pair (initializes/syncs) and a concrete resource (.obsidian/graph.json and app.json) plus the preset tag color profiles, so the agent knows exactly what gets produced. No sibling in the list does anything comparable, so no differentiation is needed, but the description also doesn't say what 'sync' means operationally.

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

Usage Guidelines2/5

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

There is no statement of when to run this – first-time setup vs. re-sync, or when 'local' scope should be chosen over 'global'. The only usage hint is implicit in the override_existing arg name, which the agent must infer from the schema.

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