Obsidian MCP Server

<div align="center"> <img src="https://github.com/user-attachments/assets/58897c99-bc54-4a88-8c7a-b04233d688a1" alt="Header Image" width="800">

<h1>obsidian-mcp MCP 服务器</h1>

<p> <a href="https://github.com/Sunwood-ai-labs/obsidian-mcp"> <img src="https://img.shields.io/github/stars/Sunwood-ai-labs/obsidian-mcp?style=social" alt="GitHub Stars"> </a> <a href="https://github.com/Sunwood-ai-labs/obsidian-mcp/issues"> <img src="https://img.shields.io/github/issues/Sunwood-ai-labs/obsidian-mcp" alt="GitHub Issues"> </a> <a href="https://github.com/Sunwood-ai-labs/obsidian-mcp/blob/main/LICENSE"> <img src="https://img.shields.io/github/license/Sunwood-ai-labs/obsidian-mcp" alt="License"> </a> </p>

<p> <img src="https://img.shields.io/badge/TypeScript-3178C6?logo=typescript&logoColor=white" alt="TypeScript"> <img src="https://img.shields.io/badge/Node.js-339933?logo=node.js&logoColor=white" alt="Node.js"> <img src="https://img.shields.io/badge/Obsidian-7C3AED?logo=obsidian&logoColor=white" alt="Obsidian"> <img src="https://img.shields.io/badge/MCP-FF6F61?logo=data:image/svg+xml;base64,..." alt="MCP"> </p> </div>

一个用于 Obsidian 集成的模型上下文协议服务器

这是一个基于 TypeScript 的 MCP 服务器，实现了与 Obsidian 的集成。它通过提供以下内容来演示核心 MCP 概念：

• 代表 Obsidian vault 内容的资源
• 用于访问 vault 数据的工具
• 与 Obsidian 的 API 集成

项目统计

• 总代码行数：345
• 主要文件：
  • src/tool-handlers.ts (76 行)
  • src/resource-handlers.ts (45 行)
  • src/server.ts (32 行)
  • src/api-client.ts (25 行)

目录结构

obsidian-mcp/
├── .codegpt/
│   └── head
├── src/
│   ├── api-client.ts
│   ├── index.ts
│   ├── resource-handlers.ts
│   ├── server.ts
│   └── tool-handlers.ts
├── .SourceSageignore
├── package.json
├── README.md
└── tsconfig.json

功能

资源

• 通过 obsidian://server-info URI 访问 Obsidian 服务器信息
• 获取带有元数据的 vault 内容
• JSON 格式，易于集成

工具

• get_vault_contents - 检索 Obsidian vault 的内容
  • 接受路径作为可选参数（默认：根目录）
  • 返回结构化的 JSON 响应

API 集成

• 与 Obsidian API 的安全 HTTPS 连接
• 具有错误处理的自定义 axios 客户端
• Windows 路径规范化支持

开发

前提条件

• Node.js v18+
• TypeScript 5.3+
• Obsidian API 密钥（设置为 OBSIDIAN_API_KEY 环境变量）

设置

# 安装依赖
npm install

# 构建服务器
npm run build

# 启动具有自动重建功能的开发服务器
npm run watch

安装

要与 Claude Desktop 一起使用，请添加服务器配置：

在 MacOS 上：~/Library/Application Support/Claude/claude_desktop_config.json 在 Windows 上：%APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "obsidian-mcp": {
      "command": "/path/to/obsidian-mcp/build/index.js",
      "env": {
        "OBSIDIAN_API_KEY": "your-api-key-here"
      }
    }
  }
}

调试

我们建议使用 MCP Inspector：

npm run inspector

Inspector 将提供一个 URL，用于访问浏览器中的调试工具。

依赖项

运行时

• @modelcontextprotocol/sdk: MCP 服务器实现
• axios: 用于 API 通信的 HTTP 客户端

开发

• @types/node: Node.js 的 TypeScript 定义
• typescript: TypeScript 编译器