使用说明
黑曜石HTTP MCP
最后使用Claude Code来管理你的黑曜石笔记——不再有崩溃或管道破裂
第一个用于Obsidian的HTTP原生MCP服务器,解决了影响Claude Code CLI的stdio传输错误(#3071, #9176, #9662)
也兼容:Claude Desktop、Codex、Gemini和其他MCP客户
为什么存在
Obsidian的第一个HTTP原生MCP服务器。解决影响Claude Code CLI的stdio传输故障(BrokenPipeError)。HTTP完全绕过了这些问题。
快速高效:响应时间<200ms,API调用次数减少70%,MCP针对最低令牌使用量进行了优化
🎬 在行动中看到它
Claude Code通过HTTP原生MCP控制黑曜石金库-没有stdio错误,只有无缝的AI笔记管理
目录
🎯 是什么让这与众不同?
✅ 工作的HTTP -没有stdio崩溃,没有BrokenPipeError,没有挫折感
⏱️ 闪电般快速 -即时创建、查找、编辑和移动笔记,即使有拼写错误
🛡️ 永不丢失数据 -内置保护,防止意外删除
⚙️ 1分钟内完成设置 -无需复杂的配置,开箱即用
💪 专为实际使用而打造 -处理数千张钞票而不会减速
💸 代币意识 -智能设计最大限度地降低了人工智能的使用成本
⚡ 快速入门(1分钟)
💡 代码库新手? 请人工智能助手指导您: “根据README.md和TECHNICAL.md,向我介绍HTTP原生MCP服务器的工作原理”
先决条件
- 黑曜石 随着 本地REST API插件
- Node.js 18+ - 点击此处下载
- MCP兼容AI (例如。, 克劳德代码CLI克劳德桌面、Codex等)
步骤1:配置黑曜石插件
- 设置→ 社区插件→ 搜索“本地REST API”→ 启用
- 启用“非加密(HTTP)API”
- 复制API密钥 (接下来你需要它)
步骤2:安装和设置
在安装黑曜石的地方安装:
npm install -g obsidian-http-mcp
obsidian-http-mcp --setup
# Enter your Obsidian API key when prompted
# Press Enter to accept defaults for URL and port
配置已保存到 ~/.obsidian-mcp/config.json -你无需再次输入此内容。
跨平台用户: 如果您的AI在WSL2上运行,但在Windows上运行Obsidian,请在Windows上安装服务器。
步骤3:启动服务器
安装位置(与Obsidian相同的系统):
obsidian-http-mcp
⚠️ 保持此终端运行。 重新启动后,运行 obsidian-http-mcp 再一次。
第四步:连接你的人工智能
如果你的AI在服务器安装的地方运行:
claude mcp add -s user --transport http obsidian-http http://localhost:3000/mcp # Adapt command to your AI
如果你的AI在别处运行 (例如,WSL2上的Claude,Windows上的服务器):
- 在上查找服务器的IP地址 服务器运行的系统:
# Windows PowerShell
ipconfig | findstr "vEthernet"
# Linux
ip addr show | grep inet
- 连接来源 你的AI在哪里运行:
claude mcp add -s user --transport http obsidian-http http://SERVER_IP:3000/mcp # Adapt command to your AI
第五步:与你的人工智能一起使用
在安装AI的地方运行(Windows、Linux或WSL2):
claude # Or your AI CLI command
# Try: "List all folders in my Obsidian vault"
就是这样! 每次您开始对话时,您的AI都会自动连接到服务器(只要服务器正在运行)。
🔄 更新中
要更新到最新版本:
npm install -g obsidian-http-mcp@latest
更新后,重新启动服务器:
obsidian-http-mcp
✨ 你的黑曜石,由人工智能驱动
不再在AI和Obsidian之间切换 -直接从AI助手控制您的保险库
永不丢失数据 -软删除可防止意外的AI操作(文件移动到 .trash-http-mcp/ 默认情况下)
以AI速度工作 -模糊搜索即使有打字错误也能找到文件,智能缓存将API调用减少70%
自信地扩展 -处理1000+张钞票而不流汗(响应时间<200ms)
您可以做什么:
- 无需离开人工智能对话,即可无缝地阅读、编写和编辑笔记
- 通过模糊匹配立即查找任何文件(“会议笔记”查找“meeting-notes-2024.md”)
- 使用完整的正则表达式支持,在几秒钟内搜索数千条笔记
- 移动、重命名或删除具有内置安全功能的文件
看 技术.md 了解完整的工具规格和架构细节。
📖 命令行选项
obsidian-http-mcp --help
Options:
--setup Interactive setup (saves to ~/.obsidian-mcp/config.json)
--api-key <key> Obsidian REST API key (overrides config)
--base-url <url> Obsidian REST API URL (default: http://127.0.0.1:27123)
--port <port> Server port (default: 3000)
--help, -h Show help
--version, -v Show version
Config Priority:
1. CLI arguments (--api-key, --base-url, --port)
2. Environment variables (OBSIDIAN_API_KEY, OBSIDIAN_BASE_URL, PORT)
3. Config file (~/.obsidian-mcp/config.json)
4. .env file
替代方法:使用.env文件 (与黑曜石系统相同):
- 创建
.env随着OBSIDIAN_API_KEY=your_key - 运行:
obsidian-http-mcp(Windows PowerShell或Linux终端)
🔧 故障排除
WSL2:连接被拒绝
查找您的Windows网桥IP:
开 Windows PowerShell (非WSL2):
ipconfig | findstr "IPv4"
# Look for "vEthernet (WSL)" interface
# Example output: IPv4 Address. . . . . . . . . . . : 172.19.32.1
然后从重新连接 WSL2终端:
claude mcp add -s user --transport http obsidian-http http://YOUR_IP:3000/mcp
# Replace YOUR_IP with the IP from above
为什么不
127.0.0.1:27123直接? 端口27123是Obsidian的REST API(自定义HTTP协议)。端口3000是MCP服务器,用于在MCP协议(由您的AI使用)和Obsidian的REST API之间进行转换。它们是不同的协议——MCP服务器充当翻译器/代理。
Windows防火墙阻止WSL2
运行在 以管理员身份使用Windows PowerShell:
New-NetFirewallRule -DisplayName "MCP Server" -Direction Inbound -LocalPort 3000 -Protocol TCP -Action Allow
端口已在使用中
在与Obsidian相同的系统上运行(Windows PowerShell或Linux终端):
obsidian-http-mcp --api-key YOUR_KEY --port 3001
需要更多帮助? 看 故障排除.md 详细的故障排除和 技术.md 对于网络架构。
⚠️ 安全通知
专为可信网络而设计 (本地主机、局域网、VPN)。对于生产部署:
- 使用带有身份验证的反向代理(nginx/caddy)
- 启用HTTPS/TLS
- 配置速率限制
- 看 安全.md 查看完整清单
当前状态:绑定到 0.0.0.0 跨平台兼容性(WSL2↔ Windows)。不要直接接触互联网。
🤝 贡献
看 贡献.md 用于开发设置和指南。
📝 许可证
麻省理工学院-参见 许可证
🌟 支持
如果这个项目对你有帮助,请在GitHub上加星!
🔗 相关
内置于❤️ 黑曜石+人工智能社区