Skip to main content
Glama
j-shelfwood

Obsidian Local REST API MCP Server

by j-shelfwood

get_note

Retrieve a specific note's content and metadata from your Obsidian vault using its file path. This tool enables access to stored information for reading or processing within the MCP server environment.

Instructions

Get a specific note with its content and metadata (legacy)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesPath to the note

Implementation Reference

  • Core handler function in ObsidianApiClient that executes the tool logic by making an HTTP GET request to the Obsidian REST API's /notes/{path} endpoint to retrieve the note content and metadata.
    async getNote(path: string) {
      return this.request(`/notes/${encodeURIComponent(path)}`);
    }
  • src/index.ts:399-409 (registration)
    Registration of the 'get_note' tool in the ListToolsRequestHandler response, including name, description, and input schema.
    {
      name: "get_note",
      description: "Get a specific note with its content and metadata (legacy)",
      inputSchema: {
        type: "object",
        properties: {
          path: { type: "string", description: "Path to the note" },
        },
        required: ["path"],
      },
    },
  • Input schema definition for the 'get_note' tool, specifying the required 'path' parameter.
    inputSchema: {
      type: "object",
      properties: {
        path: { type: "string", description: "Path to the note" },
      },
      required: ["path"],
    },
  • Dispatch routing in the CallToolRequestHandler switch statement that invokes the getNote handler for 'get_note' tool calls.
    case "get_note":
      result = await this.client.getNote(args?.path as 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 retrieves content and metadata, but lacks details on permissions, error handling (e.g., if the note doesn't exist), rate limits, or output format. The 'legacy' qualifier hints at potential deprecation but is vague, leaving critical behavioral traits unspecified.

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 description is a single, efficient sentence that front-loads the core purpose. The 'legacy' qualifier adds context without unnecessary verbosity. However, it could be slightly more structured by explicitly separating functionality from caveats.

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 lack of annotations and output schema, the description is incomplete for a retrieval tool. It doesn't explain what 'metadata' includes, the return format, or error conditions. With 1 parameter and 100% schema coverage, the basics are covered, but behavioral and output details are missing, making it inadequate for full agent understanding.

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 the 'path' parameter clearly documented. The description adds no additional parameter semantics beyond what the schema provides, such as format examples or constraints. Baseline 3 is appropriate since the schema adequately covers the single parameter.

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 ('Get') and resource ('a specific note'), specifying it retrieves both content and metadata. It distinguishes from siblings like 'list_notes' or 'get_recent_notes' by focusing on a single note. However, the 'legacy' qualifier is vague and doesn't fully differentiate from alternatives like 'read_file'.

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 explicit guidance on when to use this tool versus alternatives is provided. The description implies it's for retrieving a single note, but it doesn't clarify prerequisites (e.g., note must exist), exclusions, or comparisons to siblings like 'read_file' or 'get_daily_note'. The 'legacy' hint is insufficient as actionable guidance.

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/j-shelfwood/obsidian-local-rest-api-mcp'

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