开源项目安装与配置指南:MCP-Obsidian

开源项目安装与配置指南:MCP-Obsidian

mcp-obsidian A connector for Claude Desktop to read and search an Obsidian vault. mcp-obsidian 项目地址: https://gitcode.com/gh_mirrors/mcp/mcp-obsidian

项目基础介绍

MCP-Obsidian 是一个开源项目,旨在为 Claude Desktop 或任何 MCP 客户端提供一个连接器,使其能够读取和搜索包含 Markdown 笔记的任何目录,例如 Obsidian 文件库。该项目允许用户通过 MCP 协议与 Obsidian vault 交互。

该项目主要使用 JavaScript 语言开发。

项目使用的关键技术和框架

  • MCP (Model Context Protocol):一种允许不同应用程序之间共享上下文的协议。
  • Smithery:一个自动化安装和配置 MCP 插件的命令行工具。
  • npm:Node.js 包管理器,用于安装和管理项目的依赖关系。

安装和配置准备工作

在开始安装之前,请确保您的系统中已安装以下软件:

  1. Claude Desktop:MCP 客户端,用于与 MCP 插件交互。
  2. Node.js:JavaScript 运行环境,包括 npm 包管理器。
  3. Git:版本控制工具,用于克隆和更新项目。

详细安装步骤

1. 克隆项目

首先,使用 Git 克隆项目到本地计算机:

git clone https://github.com/smithery-ai/mcp-obsidian.git
cd mcp-obsidian

2. 安装依赖

在项目目录中,使用 npm 安装项目依赖:

npm install

3. 使用 Smithery 安装

为了通过 Smithery 自动安装 MCP-Obsidian 插件,执行以下命令:

npx @smithery/cli install mcp-obsidian --client claude

安装完成后,重启 Claude Desktop,您应该能够看到列出的 MCP 工具。

4. 手动配置 VS Code

如果您希望在 Visual Studio Code 中使用 MCP-Obsidian,您可以进行以下操作:

  1. 打开 VS Code。
  2. 按下 Ctrl + Shift + P,输入 Preferences: Open User Settings (JSON) 并选择它。
  3. 在打开的 settings.json 文件中,添加以下 JSON 配置:
{
  "mcp": {
    "inputs": [
      {
        "type": "promptString",
        "id": "vaultPath",
        "description": "Path to Obsidian vault"
      }
    ],
    "servers": {
      "obsidian": {
        "command": "npx",
        "args": ["-y", "mcp-obsidian", "${input:vaultPath}"]
      }
    }
  }
}

或者,您可以在工作区的 .vscode/mcp.json 文件中添加上述配置,以便与他人共享配置。

完成以上步骤后,您就可以开始使用 MCP-Obsidian 项目了。如果您在使用过程中遇到任何问题,请查看项目的官方文档或联系项目维护者以获取帮助。

mcp-obsidian A connector for Claude Desktop to read and search an Obsidian vault. mcp-obsidian 项目地址: https://gitcode.com/gh_mirrors/mcp/mcp-obsidian

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

凌萍鹃Dillon

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值