黑曜石REST MCP
MCP(模型上下文协议)服务器,用于封装 黑名单本地REST API 插件,使AI助手能够与您的黑曜石金库进行交互。
建于 FastMCP -根据OpenAPI规范自动生成工具。
为什么选择此服务器
REST API的大多数MCP包装器都是通过手动将每个端点重新实现为定制工具来维护的。这种方法往往会随着时间的推移而变化:当底层REST API添加/重命名/更改端点时,MCP服务器需要一个代码更新(和一个新版本)来跟进。
此服务器不同:它 直接从Obsidian本地REST API OpenAPI规范动态生成工具.
- 与REST API保持同步:当插件的OpenAPI规范发生变化时,此服务器的工具界面会自动更新(无需手动更新数十个包装器)。
- 更少的破损/更少的维护:与插件相比,MCP实现过时的地方更少。
- 全面覆盖:您可以将一整套记录在案的端点作为工具公开。
先决条件
- 码头工人
配置
从获取API密钥 黑曜石设置→ 本地REST API.
环境变量
| 变量 | 描述 | 默认值 |
|---|---|---|
OBSIDIAN_API_KEY | 来自Obsidian本地REST API插件 | 的API密钥(必需) |
OBSIDIAN_REST_URL | REST API的基本URL | https://127.0.0.1:27124 |
OBSIDIAN_OPENAPI_PATH | OpenAPI规范之路 | /openapi.yaml |
用法
VS代码(MCP)
请参阅VS Code MCP配置中的检查 .vscode/mcp.json.
注: 在macOS/Windows上,容器通常可以通过以下方式访问您计算机上的服务https://host.docker.internal:27124. 在Linux上,您可能需要--network=host(或等效的主机网关设置),以便容器访问Obsidian REST API。
可用工具
此服务器公开来自Obsidian本地REST API的所有终结点。
文档(Swagger):https://coddingtonbear.github.io/obsidian-local-rest-api/
许可证
麻省理工学院
