Obsidian笔记交互协议

一个允许通过MCP协议与Obsidian笔记库交互的服务,支持Python和TypeScript实现,适用于AI驱动的笔记管理场景。

  • by hslrock
  • Python
  • 本地部署
  • 2 星标
  • 更新于
在 GitHub 查看 hslrock/ObsidianMCP

使用说明

黑曜石MCP-社区版(HSL)

与Obsidian vault交互 模型上下文协议 (MCP)服务器。可以在Claude Code、Cursor等支持MCP的客户端上查看、创建、修改Obsidian笔记、标签、链接、模板、文件夹等。

这个项目没有人的介入。 只用AI制作而成。, python和 TypeScript 提供两种实施:

快速安装(TypeScript/npm)

npm install -g obsidian-mcp-hsl-ce

从Claude Code添加

claude mcp add-json obsidian '{"type":"stdio","command":"obsidian-mcp-hsl-ce","args":["~/Documents/Obsidian/MyVault"]}'

无需安装(npx)

无需全局安装 npx也可以根据需要自动导入并运行:

claude mcp add-json obsidian '{"type":"stdio","command":"npx","args":["-y","obsidian-mcp-hsl-ce","~/Documents/Obsidian/MyVault"]}'

Cursor/其他MCP客户端

添加到MCP配置文件(JSON):

{
  "mcpServers": {
    "obsidian": {
      "command": "obsidian-mcp-hsl-ce",
      "args": ["~/Documents/Obsidian/MyVault"]
    }
  }
}

args请将的路径更改为您自己的Obsidian vault路径。


项目结构

ObsidianMCP/
├── obsidian-mcp-py/    # Python 구현
│   ├── main.py
│   ├── run_server.py
│   ├── settings.py
│   ├── pyproject.toml
│   ├── obsidian/
│   ├── CURSOR_SETUP.md
│   └── CLAUDE_SETUP.md
├── obsidian-mcp-ts/    # TypeScript 구현
│   ├── src/
│   │   ├── main.ts
│   │   ├── settings.ts
│   │   └── obsidian/
│   ├── package.json
│   └── tsconfig.json
└── README.md

Python版本

要求

安装和运行

cd obsidian-mcp-py

# 의존성 설치
uv sync

# 환경 변수 설정
echo 'OBSIDIAN_VAULT_PATH=/path/to/your/vault' > .env

# MCP 서버 실행 (stdio 모드)
uv run python main.py

# HTTP 서버로 실행 (선택)
uv run python run_server.py --http

MCP客户端设置(Cursor)

{
  "mcpServers": {
    "obsidian": {
      "command": "/path/to/obsidian-mcp-py/.venv/bin/python",
      "args": ["/path/to/obsidian-mcp-py/main.py"],
      "env": {
        "OBSIDIAN_VAULT_PATH": "/path/to/your/vault"
      }
    }
  }
}

有关详细设置,请参阅 CURSOR_SETUP.md 及 CLAUDE_SETUP.md请参考。


TypeScript版本(npm: obsidian-mcp-hsl-ce)-社区版

安装

# 글로벌 설치 (권장)
npm install -g obsidian-mcp-hsl-ce

# 또는 설치 없이 npx로 실행
npx -y obsidian-mcp-hsl-ce ~/Documents/Obsidian/MyVault

# 또는 소스에서 직접
cd obsidian-mcp-ts
npm install && npm run build

MCP客户端设置(Claude Code/Cursor)

全局安装后,只需将vault路径作为参数传递:

{
  "mcpServers": {
    "obsidian": {
      "command": "obsidian-mcp-hsl-ce",
      "args": ["~/Documents/Obsidian/MyVault"]
    }
  }
}

npx无需全局安装即可使用:

{
  "mcpServers": {
    "obsidian": {
      "command": "npx",
      "args": ["-y", "obsidian-mcp-hsl-ce", "~/Documents/Obsidian/MyVault"]
    }
  }
}

仍然支持环境变量方法:

{
  "mcpServers": {
    "obsidian": {
      "command": "obsidian-mcp-hsl-ce",
      "env": {
        "OBSIDIAN_VAULT_PATH": "/path/to/your/vault"
      }
    }
  }
}

Vault路径优先级: CLI参数 > 环境变量 > 浏览默认路径


交付工具(40个)

两个版本都提供相同的工具。

域 工具
备注 read_obsidian_note, create_obsidian_note, update_obsidian_note, list_obsidian_notes, search_obsidian_notes
标签 get_note_tags, search_by_tag, add_tag_to_note, remove_tag_from_note, list_all_tags
链接 get_note_links, get_backlinks, create_link_between_notes, find_orphaned_notes, find_broken_links
模板 list_templates, create_note_from_template, save_template, get_template
每日笔记 create_daily_note, get_daily_note, list_daily_notes
统计 get_vault_statistics, get_note_statistics, find_most_linked_notes, get_note_graph_data
文件夹 create_folder, move_note, list_folders, get_folder_statistics, delete_folder
搜索 search_by_regex, search_by_date_range, fuzzy_search_note
嵌入/块 get_note_blocks, update_block, embed_note, get_note_embeds, remove_embed
服务器 get_server_info

许可证

遵守项目中规定的许可证。