Skip to main content
Glama

get_note

Read note content from an Obsidian vault by specifying its file path to access and review information stored in your knowledge base.

Instructions

Read the full content of a note by its path

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesRelative path to the note within the vault

Implementation Reference

  • The get_note tool handler is defined and registered in src/tools/read.ts. It calls readNote to fetch the file contents, parses frontmatter, and formats the response.
    server.registerTool(
      "get_note",
      {
        description: "Read the full content of a note by its path",
        inputSchema: {
          path: z
            .string()
            .min(1)
            .describe("Relative path to the note within the vault"),
        },
      },
      async ({ path: notePath }) => {
        try {
          const content = await readNote(vaultPath, notePath);
          const { data: frontmatterData, content: bodyContent } = parseFrontmatter(content);
    
          const header: string[] = [];
          if (Object.keys(frontmatterData).length > 0) {
            header.push("--- Frontmatter ---");
            for (const [key, value] of Object.entries(frontmatterData)) {
              header.push(`${key}: ${JSON.stringify(value)}`);
            }
            header.push("--- End Frontmatter ---");
            header.push("");
          }
    
          const tags = extractTags(content);
          if (tags.length > 0) {
            header.push(`Tags: ${tags.join(", ")}`);
            header.push("");
          }
    
          return {
            content: [
              {
                type: "text" as const,
                text: header.length > 0
                  ? header.join("\n") + bodyContent
                  : content,
              },
            ],
          };
        } catch (err) {
          console.error("get_note error:", err);
          return errorResult(`Error reading note: ${err instanceof Error ? err.message : String(err)}`);
        }
      },
    );
Behavior2/5

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

With no annotations provided, the description carries full burden but only states it reads content without disclosing behavioral traits like error handling (e.g., if the path doesn't exist), permissions required, or rate limits. It adds minimal context beyond the basic action.

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 ('Read the full content of a note') without any wasted words. It's appropriately sized for a simple tool with one parameter.

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?

Given the tool's low complexity (one parameter, no output schema, no annotations), the description is minimally adequate but lacks details on output format or error cases. It covers the basic purpose but doesn't fully compensate for missing structured data.

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?

Schema description coverage is 100%, so the schema already documents the 'path' parameter fully. The description adds no additional meaning beyond what the schema provides, such as path format examples or constraints, meeting the baseline for high 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 ('Read') and resource ('full content of a note'), making the purpose immediately understandable. However, it doesn't distinguish this from similar tools like 'read_canvas' or 'get_daily_note' that might also retrieve content, missing sibling differentiation.

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?

No guidance is provided on when to use this tool versus alternatives like 'get_daily_note' for date-specific notes or 'search_notes' for broader queries. The description implies usage by specifying 'by its path' but offers no explicit context or exclusions.

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/rps321321/obsidian-mcp-pro'

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