Skip to main content
Glama
j-shelfwood

Obsidian Local REST API MCP Server

by j-shelfwood

read_file

Retrieve content from files in your Obsidian vault to access notes and data for processing or analysis.

Instructions

Read content of a specific file from the vault

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesPath to the file

Implementation Reference

  • MCP tool call handler for 'read_file' tool: extracts path argument and delegates execution to the ObsidianApiClient.readFile method.
    case "read_file":
      result = await this.client.readFile(args?.path as string);
      break;
  • src/index.ts:290-300 (registration)
    Registration of the 'read_file' tool in the ListTools response, including name, description, and input schema definition.
    {
      name: "read_file",
      description: "Read content of a specific file from the vault",
      inputSchema: {
        type: "object",
        properties: {
          path: { type: "string", description: "Path to the file" },
        },
        required: ["path"],
      },
    },
  • Core helper method in ObsidianApiClient that performs the HTTP GET request to retrieve file content from the Obsidian REST API.
    async readFile(path: string) {
      return this.request(`/files/${encodeURIComponent(path)}`);
    }
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 action is to 'read' content, implying a read-only operation, but doesn't address potential behavioral aspects such as file format handling, error conditions (e.g., if the file doesn't exist), or performance considerations like size limits.

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 directly states the tool's purpose without any unnecessary words. It is front-loaded with the core action and resource, making it easy to parse quickly.

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. However, it lacks details on return values (e.g., content format) and doesn't leverage the absence of annotations to clarify behavioral traits, leaving gaps for a read operation.

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 semantic context beyond what the schema provides, such as examples of valid paths or vault-specific conventions, so it 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 ('Read content') and resource ('specific file from the vault'), making the purpose immediately understandable. However, it doesn't explicitly differentiate from sibling tools like 'get_note' or 'list_directory', which might also involve reading files or content from the vault.

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 when to choose 'read_file' over similar siblings like 'get_note' or 'search_vault', nor does it specify any prerequisites or exclusions for usage.

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