Obsidian MCP Module

Obsidian MCP Module

site icon
2025.04.15 0
TypeScript笔记管理知识库工具开发效率
Obsidian MCP Module 是一个为读取 Obsidian 知识库(vaults)提供的 MCP 服务器。它支持通过 MCP 工具和资源访问笔记内容,适用于不同客户端(如 VS Code)的需求。
View on GitHub

Overview

基本能力

产品定位

Obsidian MCP Module 是一个用于读取和管理 Obsidian 知识库的工具,旨在提供高效的笔记搜索和内容检索功能。

核心功能

  • search-notes: 按主题搜索笔记
  • get-note: 检索笔记内容

适用场景

  • 在 VS Code 或其他支持 MCP 的客户端中快速访问 Obsidian 笔记
  • 需要从 Obsidian 知识库中搜索特定主题的笔记
  • 需要获取特定笔记的详细内容

工具列表

  • search-notes: 按主题搜索笔记
  • get-note: 检索笔记内容

常见问题解答

使用教程

使用依赖

安装教程

VS Code

  1. .vscode/mcp.json 文件中添加以下配置:
{
    "servers": {
        "obsidian-mcp": {
            "type": "stdio",
            "command": "deno",
            "args": [
                "run",
                "--allow-read",
                "${workspaceFolder}/main.ts",
                "--vaultPath=/path/to/vault"
            ]
        }
    }
}

Claude Desktop

  1. 在配置文件中添加以下内容:
{
    "mcpServers": {
      "filesystem": {
        "command": "/path/to/deno",
        "args": [
            "run",
            "--allow-read",
            "/path/to/main.ts",
            "--vaultPath=/path/to/vault"
        ]
      }
    }
  }

调试方式

  • 确保 Deno 运行时环境已正确安装
  • 确保 Obsidian 知识库路径 (--vaultPath) 配置正确
  • 检查 metadata.json 文件是否已由 Obsidian Metadata Extractor 插件生成

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。