Skip to main content
Glama
Obsidian MCP

Obsidian MCP

by takuya0206

Obsidian MCP(模型上下文协议)

Obsidian MCP 是一款工具,允许您使用模型上下文协议 (MCP) 与 Obsidian Vault 进行交互。这使得 AI 助手能够通过标准化界面读取、写入和操作 Obsidian Vault 中的笔记。

先决条件

  • Node.js 18 或更高版本

  • 安装并配置了本地 REST API 插件的 Obsidian

  • 从本地 REST API 插件生成的 API 密钥

Related MCP server: Obsidian MCP Server Plugin

设置 MCP 服务器(例如 Claude 桌面应用程序)

  1. 克隆此存储库

  2. 安装依赖项:

    npm install
  3. 构建项目:

    npm run build
  4. 配置 Claude 桌面应用程序以使用此 MCP 服务器:

    {
       "mcpServers": {
         "Obsidian": {
           "command": "node",
           "args": ["/Users/<Your Own Path>/obsisian-mcp/build/index.js"],
           "env": {
             "apiKey": "<Your API Token>",
             "port": "27123",
             "host": "127.0.0.1"
           }
         }
       }
     }

发展

创建.env并按照上面提到的配置“apiKey”、“port”和“host”。

可用工具

实施了以下工具:

  1. readNote - 阅读特定注释的内容

    {
      "path": "path/to/note.md"
    }
  2. readActiveNote - 读取当前活动笔记的内容

    {}
  3. listNotes - 递归列出整个 Vault 中或指定文件夹下的文件和文件夹

    {
      "path": "optional/folder/path"
    }
  4. patchNote - 将内容插入到相对于标题、块引用或前置字段的现有注释中

    {
      "path": "path/to/note.md",
      "operation": "append|prepend|replace",
      "targetType": "heading|block|frontmatter",
      "target": "target_identifier",
      "content": "content to insert"
    }
  5. searchWithJsonLogic - 使用 JsonLogic 格式查询搜索 Obsidian 笔记

    {
      "query": {
        // JsonLogic query object
      }
    }

Available Tools

5 tools
listNotesA

Recursively lists files and folders in the entire Vault or under a specified folder and returns the result as a tree-format string

Inputs: path.

patchNoteC

Inserts content into an existing note relative to a heading, block reference, or frontmatter field.

Inputs: path (required), operation (required), targetType (required), target (required), +4 more.

readActiveNoteB

Read the contents of the current active note

Inputs: no named parameters.

readNoteC

Read the contents of a specific note

Inputs: path (required).

searchWithJsonLogicB

Search Obsidian notes using JsonLogic format queries. Using logical conditions expressed in JSON, you can flexibly filter note metadata and content. Suitable for programmatically generated searches, allowing complex conditions to be expressed in a structured way.

Inputs: query (required).

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    B3.1/5.0

    Scored across 5 tools

    Disambiguation4/5

    Most tools have distinct purposes: listNotes for browsing, readNote/readActiveNote for reading, patchNote for editing, and searchWithJsonLogic for querying. However, readNote and readActiveNote could potentially be confused as they both read notes, though one targets a specific note and the other the active note, which is clarified in their descriptions.

    Naming Consistency3/5

    The naming is mixed: listNotes, readNote, and searchWithJsonLogic follow a verb_noun pattern, but patchNote uses a verb_noun format with a different verb style, and readActiveNote includes an adjective, breaking consistency. While readable, it lacks a uniform convention across all tools.

    Tool Count4/5

    With 5 tools, the count is reasonable for an Obsidian vault management server, covering core operations like listing, reading, editing, and searching notes. It's slightly lean but functional, as it includes essential CRUD-like actions without being overwhelming.

    Completeness3/5

    The tool set covers reading, editing, listing, and searching notes, but lacks explicit create and delete operations for notes, which are common in file-based systems. This creates gaps in full lifecycle management, though patchNote can modify existing notes and agents might work around missing create/delete by other means.

    Maintenance

    ActivityInactive
    ResponsivenessNo recent community issues

    Related MCP Connectors

    Related MCP Servers

    • A
      license
      Not graded
      quality
      D
      maintenance
      Turns an Obsidian vault into a local Model Context Protocol server that allows AI tools to directly read, search, and write to your notes. It features folder-level access control and a built-in dashboard for easy integration with tools like Claude Desktop and Cursor.
      2
      MIT
    • A
      license
      A
      quality
      F
      maintenance
      A Model Context Protocol (MCP) server that provides AI assistants with secure access to Obsidian vaults. Enables reading, writing, searching, and managing notes without requiring Obsidian to be running.
      50
      7,721 npm
      Apache 2.0
    • F
      license
      Not graded
      quality
      C
      maintenance
      MCP server that provides tools and resources for AI models to interact with an Obsidian vault, enabling file operations, search, and management via the Model Context Protocol.
      2
      -