Obsidian模型上下文协议(MCP-Obsidian)使用指南
1. 项目介绍
Obsidian模型上下文协议(MCP-Obsidian)是一个开源项目,旨在允许Claude Desktop或任何MCP客户端读取和搜索包含Markdown笔记的任何目录,例如Obsidian知识库。该项目的核心功能是为用户提供一个连接器,以便在Claude Desktop中直接访问和搜索Obsidian vault中的笔记。
2. 项目快速启动
安装
确保您的系统中已安装Claude Desktop和npm。
通过Smithery自动安装:
npx @smithery/cli install mcp-obsidian --client claude
然后,重启Claude Desktop。您应该在MCP工具列表中看到以下内容。
在VS Code中的使用
对于快速安装,可以使用下面的一键安装按钮:
对于手动安装,将以下JSON块添加到VS Code中的用户设置(JSON)文件中。您可以通过按下Ctrl + Shift + P
并输入Preferences: Open User Settings (JSON)
来执行此操作。或者,您可以在工作空间中添加一个名为.vscode/mcp.json
的文件,以便与团队成员共享配置。
请注意,在.vscode/mcp.json
文件中不需要mcp
键。
{
"inputs": [
{
"type": "promptString",
"id": "vaultPath",
"description": "Path to Obsidian vault"
}
],
"servers": {
"obsidian": {
"command": "npx",
"args": [
"-y",
"mcp-obsidian",
"${input:vaultPath}"
]
}
}
}
3. 应用案例和最佳实践
- 个人知识库管理:使用MCP-Obsidian连接您的Obsidian vault,实现快速搜索和访问个人笔记。
- 团队协作:在团队项目中,通过MCP-Obsidian共享访问知识库,提高协作效率。
4. 典型生态项目
目前,MCP-Obsidian项目主要是作为一个独立的项目存在,其生态系统尚未广泛形成。然而,随着项目的成熟和社区的发展,未来可能会出现一系列围绕MCP-Obsidian构建的工具和插件,以进一步扩展其功能和用途。
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考