Obsidian MCP REST Server

黑曜石MCP REST服务器

一种MCP（模型上下文协议）服务器实现，通过本地REST API提供对黑社会保险库的访问。该服务器允许AI助手与黑曜石笔记交互，并通过标准化界面管理保管库内容。

特性

• 通过MCP访问黑曜石保险库内容
• 读写笔记
• 列出保管库内容
• 搜索功能
• 安全的本地REST API集成
• 与Claude Desktop和其他AI助手兼容

先决条件

• Node.js 16或更高版本
• 安装并配置了本地REST API插件的黑名单
• 启用了本地REST API的黑社会保险库

安装

全局安装软件包：

npm install -g PublikPrinciple/obsidian-mcp-rest

或者，如果您更喜欢使用特定版本/分支：

npm install -g PublikPrinciple/obsidian-mcp-rest#main

配置

1. 首先，配置Obsidian本地REST API插件：

- 在Obsidian中安装本地REST API插件 - 配置API端口（默认值：27123） - 生成并保存API密钥

1. 创建配置文件 config.json:

{
  "obsidian": {
    "apiKey": "your-api-key-here",
    "port": 27123,
    "host": "localhost"
  },
  "server": {
    "name": "obsidian-mcp",
    "version": "1.0.0"
  }
}

用法

1. 启动服务器：

obsidian-mcp-rest --config path/to/config.json

1. 服务器将启动并通过stdin/stdout监听MCP请求。

与Claude Desktop一起使用

1. 配置Claude Desktop以使用此MCP服务器：

- 打开克劳德桌面设置 - 导航到MCP部分 - 添加新的服务器配置：

     {
       "name": "obsidian-mcp",
       "command": "obsidian-mcp-rest",
       "args": ["--config", "path/to/config.json"]
     }

1. Claude现在可以通过以下命令访问您的黑曜石保险库：

   Read note "Projects/MyProject.md"
   List all notes in "Projects" folder
   Search for notes containing "typescript"

可用工具

• listNotes：列出vault或特定文件夹中的所有笔记
• readNote：阅读特定注释的内容
• writeNote：创建或更新注释
• searchNotes：使用查询字符串搜索笔记
• getMetadata：获取特定注释的元数据

安全

• 服务器仅在本地运行，并通过stdin/stdout进行通信
• 所有对Obsidian REST API的请求都使用您的API密钥进行身份验证
• 无需外部网络访问
• 数据保留在您的计算机本地

发展

1. 克隆存储库：

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

1. 安装依赖项：

npm install

1. 构建项目：

npm run build

1. 运行测试：

npm test

故障排除

安装问题

如果您遇到任何安装问题，请尝试以下替代方案：

1. 克隆并在本地安装：

git clone https://github.com/PublikPrinciple/obsidian-mcp-rest.git
cd obsidian-mcp-rest
npm install
npm run build
npm install -g .

1. 如果你看到与TypeScript相关的错误，请确保TypeScript是全局安装的：

npm install -g typescript

贡献

欢迎投稿！请随时提交拉取请求。对于重大更改，请先打开一个问题来讨论您想要更改的内容。

许可证

MIT许可证-有关详细信息，请参阅许可证文件