Skip to main content
Glama
HenriqueCSouzza

Obsidian MCP Local

get_note

Retrieve the content of a Markdown note from an Obsidian vault by providing its file path. Enables AI assistants to read note contents directly without requiring Obsidian to be open.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYes

Implementation Reference

  • Core logic: reads a markdown note from the vault by its relative path, parses frontmatter using gray-matter, and returns the path, frontmatter data, and content.
    export async function readNote(relativePath: string) {
      const finalPath = ensureMdExtension(relativePath);
      const fullPath = resolveVaultPath(finalPath);
    
      if (!(await pathExists(fullPath))) {
        throw new Error(`Note not found: ${finalPath}`);
      }
    
      const raw = await fs.readFile(fullPath, "utf-8");
      const parsed = matter(raw);
    
      return {
        path: finalPath,
        frontmatter: parsed.data,
        content: parsed.content,
      };
    }
  • Schema: expects a single 'path' string parameter (min 1 char) via Zod validation.
    { inputSchema: { path: z.string().min(1) } },
  • Tool handler: calls readNote with the provided path and returns the note as formatted JSON text.
    async ({ path }) => {
      const note = await readNote(path);
      return {
        content: [{ type: "text", text: JSON.stringify(note, null, 2) }],
      };
    },
  • Registration: registers the 'get_note' tool on the MCP server with its schema and handler.
    export function register(server: McpServer): void {
      server.registerTool(
        "get_note",
        { inputSchema: { path: z.string().min(1) } },
        async ({ path }) => {
          const note = await readNote(path);
          return {
            content: [{ type: "text", text: JSON.stringify(note, null, 2) }],
          };
        },
      );
    }
  • src/server.ts:15-15 (registration)
    Server-side registration: calls getNote.register(server) to wire up the tool.
    getNote.register(server);
Behavior1/5

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

Tool has no description.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness1/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Tool has no description.

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

Completeness1/5

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

Tool has no description.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters1/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Tool has no description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose1/5

Does the description clearly state what the tool does and how it differs from similar tools?

Tool has no description.

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

Usage Guidelines1/5

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

Tool has no description.

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/HenriqueCSouzza/obsidian-mcp-local'

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