obsidian-mcp MCP Server

基本能力

产品定位

obsidian-mcp 是一个 Model Context Protocol (MCP) 服务器，旨在为 Obsidian 提供集成支持，使其能够通过 MCP 协议访问和操作 Obsidian 保险库中的内容。

核心功能

• 资源访问：
• 通过 obsidian://server-info URI 访问 Obsidian 服务器信息
• 获取带有元数据的保险库内容

• 提供 JSON 格式的数据以便于集成

• 工具：

• get_vault_contents：检索 Obsidian 保险库的内容

  • 接受路径作为可选参数（默认为根目录）
  • 返回结构化的 JSON 响应

• API 集成：

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

适用场景

• 开发者需要将 Obsidian 保险库内容集成到其他应用程序中
• 需要自动化访问和管理 Obsidian 保险库内容的场景
• 开发与 Obsidian 集成的工具或插件

工具列表

• get_vault_contents：用于检索 Obsidian 保险库的内容，返回结构化的 JSON 数据。

常见问题解答

• 如何获取 Obsidian API 密钥？：需要设置 OBSIDIAN_API_KEY 环境变量。
• 如何调试？：推荐使用 MCP Inspector 进行调试。

使用教程

使用依赖

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

安装教程

# 安装依赖
npm install

# 构建服务器
npm run build

# 启动开发服务器（自动重建）
pm run watch

调试方式

npm run inspector

使用 MCP Inspector 提供的 URL 在浏览器中访问调试工具。

许可证

该项目遵循 MIT 开源许可条款。