Obsidian REST API 交互服务器——MCP-obsidian 安装与配置指南

Obsidian REST API 交互服务器——MCP-obsidian 安装与配置指南

mcp-obsidian MCP server that interacts with Obsidian via the Obsidian rest API community plugin 项目地址: https://gitcode.com/gh_mirrors/mc/mcp-obsidian

1. 项目基础介绍

MCP-obsidian 是一个开源项目，旨在通过 Obsidian 的 REST API 插件实现与 Obsidian 笔记库的交互。该项目使用 Python 编程语言，为开发者提供了一个服务器端解决方案，以便能够通过程序化方式操作 Obsidian 中的笔记内容。

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

• Python：项目的主要编程语言。
• Obsidian REST API 插件：使得能够通过 HTTP 请求与 Obsidian 笔记库进行交互的插件。
• uvicorn：一个 ASGI 服务器，用于运行 Python 的异步网络应用。
• Model Context Protocol (MCP)：一个定义了如何构建和运行插件的标准协议。

3. 安装和配置准备工作

在开始安装之前，请确保您的系统中已安装以下依赖：

• Python 3.8 或更高版本
• pip（Python 包管理器）
• Obsidian 以及 Obsidian Local REST API 插件（已在 Obsidian 中安装并启用）

安装步骤

1. 克隆项目到本地：

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

2. 安装项目依赖：

   pip install -r requirements.txt
   

3. 配置 Obsidian REST API 密钥：

   • 在项目根目录下创建一个 .env 文件，并添加以下内容，将 <your_api_key_here> 替换为你在 Obsidian 插件设置中生成的 API 密钥：

     OBSIDIAN_API_KEY=your_api_key_here
     

   或者，你也可以将 API 密钥直接配置在服务器的环境中，如下所示：

   {
     "mcp-obsidian": {
       "command": "uvx",
       "args": ["mcp-obsidian"],
       "env": {
         "OBSIDIAN_API_KEY": "<your_api_key_here>"
       }
     }
   }
   

4. 运行服务器：

   uvicorn src/mcp_obsidian:app --reload
   

   如果使用的是 uv 命令，则可以这样运行：

   uv run mcp-obsidian
   

5. 确保服务器正在运行，并且可以通过浏览器访问 http://127.0.0.1:8000 查看是否正常启动。

以上步骤完成后，MCP-obsidian 服务器应该已经成功安装并运行，你可以开始使用它来与你的 Obsidian 笔记库进行交互了。

mcp-obsidian MCP server that interacts with Obsidian via the Obsidian rest API community plugin 项目地址: https://gitcode.com/gh_mirrors/mc/mcp-obsidian