Skip to main content
Glama
sureshsankaran

Obsidian Tools MCP Server

update_note

Replace the entire content of an existing note in Obsidian vaults by specifying the file path and new content.

Instructions

Update/replace the entire content of an existing note

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesPath to the note to update relative to vault root
contentYesNew content for the note

Implementation Reference

  • The main handler function for the 'update_note' tool. It resolves the full file path, checks if the note exists, overwrites the file with the new content, and returns a success message.
    async function handleUpdateNote(args: {
      path: string;
      content: string;
    }): Promise<string> {
      const fullPath = resolvePath(args.path);
    
      if (!(await fileExists(fullPath))) {
        throw new Error(`Note not found at ${args.path}`);
      }
    
      await fs.writeFile(fullPath, args.content, "utf-8");
      return `Successfully updated note at ${args.path}`;
    }
  • Input schema definition for the 'update_note' tool, specifying required 'path' and 'content' parameters.
    inputSchema: {
      type: "object",
      properties: {
        path: {
          type: "string",
          description: "Path to the note to update relative to vault root",
        },
        content: {
          type: "string",
          description: "New content for the note",
        },
      },
      required: ["path", "content"],
    },
  • src/index.ts:64-81 (registration)
    Registration of the 'update_note' tool in the tools array, including name, description, and input schema. This array is returned by the ListToolsRequest handler.
    {
      name: "update_note",
      description: "Update/replace the entire content of an existing note",
      inputSchema: {
        type: "object",
        properties: {
          path: {
            type: "string",
            description: "Path to the note to update relative to vault root",
          },
          content: {
            type: "string",
            description: "New content for the note",
          },
        },
        required: ["path", "content"],
      },
    },
  • src/index.ts:873-877 (registration)
    Dispatch case in the tool call handler that routes 'update_note' calls to the handleUpdateNote function.
    case "update_note":
      result = await handleUpdateNote(
        args as { path: string; content: string }
      );
      break;
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It states the tool performs an update/replace operation, implying mutation, but lacks details on permissions, error handling (e.g., if the note doesn't exist), whether changes are reversible, or any rate limits. This is a significant gap for a mutation tool without annotation support.

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 a single, efficient sentence that front-loads the core action ('update/replace') and resource. There is no wasted language, making it easy to parse quickly while conveying the essential purpose.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's mutation nature, lack of annotations, and absence of an output schema, the description is incomplete. It doesn't cover behavioral aspects like error conditions, return values, or safety considerations, which are critical for an agent to use this tool effectively in a vault context with many sibling tools.

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?

The input schema has 100% description coverage, with clear documentation for both parameters ('path' and 'content'). The description adds minimal value beyond the schema by implying 'content' replaces the entire note, but doesn't provide additional syntax, format details, or constraints. This meets the baseline for high schema coverage.

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?

The description clearly states the action ('update/replace') and resource ('entire content of an existing note'), making the purpose immediately understandable. However, it doesn't explicitly differentiate from sibling tools like 'append_to_note', 'prepend_to_note', or 'update_frontmatter', which would require more specific language about full replacement versus partial modifications.

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?

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites (e.g., the note must exist), exclusions (e.g., not for partial updates), or refer to sibling tools like 'append_to_note' or 'update_frontmatter' for different use cases, leaving the agent to infer usage from context alone.

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/sureshsankaran/obsidian-tools-mcp'

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