Skip to main content
Glama
j-shelfwood

Obsidian Local REST API MCP Server

by j-shelfwood

find_related_notes

Discover notes connected to a specific note by analyzing shared tags, links, or backlinks within your Obsidian vault.

Instructions

Find notes related to a given note based on shared tags, links, or backlinks

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesPath to the source note
onNoRelationship criteria to use for finding related notes

Implementation Reference

  • The handler function in ObsidianApiClient class that implements find_related_notes by making an HTTP request to the Obsidian API endpoint for related notes based on tags or links.
    async findRelatedNotes(path: string, on: string[] = ["tags", "links"]) {
      const params = new URLSearchParams({
        on: on.join(","),
      });
      return this.request(`/vault/notes/related/${encodeURIComponent(path)}?${params}`);
    }
  • Input schema definition for the find_related_notes tool, specifying parameters path (required) and on (optional array of 'tags' or 'links').
    inputSchema: {
      type: "object",
      properties: {
        path: { type: "string", description: "Path to the source note" },
        on: {
          type: "array",
          items: { type: "string", enum: ["tags", "links"] },
          description: "Relationship criteria to use for finding related notes",
          default: ["tags", "links"]
        },
      },
      required: ["path"],
    },
  • src/index.ts:500-505 (registration)
    Tool registration in the MCP CallToolRequestSchema handler switch statement, dispatching calls to the client handler.
    case "find_related_notes":
      result = await this.client.findRelatedNotes(
        args?.path as string,
        args?.on as string[]
      );
      break;
  • src/index.ts:380-396 (registration)
    Tool definition and registration in the ListTools response, including name, description, and schema.
    {
      name: "find_related_notes",
      description: "Find notes related to a given note based on shared tags, links, or backlinks",
      inputSchema: {
        type: "object",
        properties: {
          path: { type: "string", description: "Path to the source note" },
          on: {
            type: "array",
            items: { type: "string", enum: ["tags", "links"] },
            description: "Relationship criteria to use for finding related notes",
            default: ["tags", "links"]
          },
        },
        required: ["path"],
      },
    },
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It mentions the relationship criteria but doesn't describe output format, pagination, error handling, or performance characteristics. For a tool with no annotations, this leaves significant gaps in understanding how it behaves.

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 purpose. Every word earns its place with no redundancy or fluff, making it highly concise and well-structured.

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 no annotations and no output schema, the description is incomplete. It doesn't explain what the tool returns (e.g., list of note paths, metadata), error cases, or limitations. For a tool with 2 parameters and no structured output, more context is needed to be fully helpful.

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 both parameters ('path' and 'on'). The description adds context by mentioning 'backlinks' as a criterion, which isn't in the enum (only 'tags' and 'links'), but this is contradictory rather than helpful. Baseline 3 is appropriate as the schema does most of the work.

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 verb ('find') and resource ('notes related to a given note'), specifying the relationship criteria ('shared tags, links, or backlinks'). It distinguishes from siblings like 'search_vault' or 'list_notes' by focusing on relationships, though it doesn't explicitly name alternatives. This is specific but lacks explicit 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 Guidelines3/5

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

The description implies usage when you need to find notes based on relationships (tags, links, backlinks), but it doesn't provide explicit guidance on when to use this versus alternatives like 'search_vault' or 'list_notes'. No exclusions or prerequisites are mentioned, leaving usage context somewhat vague.

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