Obsidian文件管理服务

一个基于TypeScript的Obsidian MCP服务器,提供与Obsidian库交互的简单接口,支持文件列表、内容搜索、修改和删除等功能。

  • by yokarilight
  • TypeScript
  • 本地部署
  • 1 星标
  • 更新于
在 GitHub 查看 yokarilight/obsidian-map-lite

使用说明

黑曜石MCP Lite

一个基于TypeScript的黑曜石MCP服务器,提供了一个与黑曜石库交互的简单界面。

特性

  • 列出vault中的文件
  • 列出目录中的文件
  • 获取文件内容
  • 从文件中搜索特定文本
  • 补丁内容
  • 附加内容
  • 删除文件

先决条件

  • Node.js>=18.16.0
  • 安装了本地REST API插件的黑名单
  • 黑石API密钥

设置

# Install dependencies
pnpm install

# Build server
pnpm run build

配置

  1. 复制 .env.example 向 .env:

    cp .env.example .env
    
  2. 编辑 .env 并设置您的Obsidian API密钥和主机:

    OBSIDIAN_API_KEY=your-api-key-here
    OBSIDIAN_HOST=http://localhost:27123
    

安装

要与Cursor一起使用,请添加以下配置:

{
  "mcpServers": {
    "obsidian-mcp-lite": {
      "command": "node",
      "args": [
        "/path/to/obsidian-mcp-lite/dist/index.js"
      ],
      "env": {
        "OBSIDIAN_API_KEY": "your-api-key-here"
      }
    }
  }
}

调试

使用MCP 检查员:

npx @modelcontextprotocol/inspector -e OBSIDIAN_API_KEY=your-api-key-here node dist/index.js"

您将在终端中找到一个URL。打开它并在浏览器中访问调试工具。