使用说明
黑曜石MCP服务器
将你的黑曜石金库连接到Amp,用人工智能增强你的笔记记录能力
使用 安培 (Sourcegraph的AI编码助手)自动创建、更新和管理您的笔记 黑曜石 拱顶。非常适合文档、学习日志、代码片段,以及在编码时构建知识库。
🚀 现在有121个综合工具 实现黑曜石的完全自动化!
✨ 特性
🎯 v4.0的新增功能
- 🎨 Canvas集成 -以编程方式创建和操纵黑曜石画布
- 📊 数据视图查询 -在vault上执行类似数据库的查询
- 🌐 图形分析 -分析知识网络,找到集群,计算中心性
- 🔗 高级URI生成 -创建到黑曜石的深度链接(黑曜岩://URI)
- 📎 增强附件 -更好的媒体文件管理
- 🔍 高级搜索和替换 -正则表达式搜索、frontmatter搜索、vault范围重构
- 🏷️ 增强元数据 -高级前端操作和批量更新
- 📚 结构化模板 -预格式化的笔记类型(书籍、人物、会议、项目)
- ✅ 增强的任务管理 -按条件筛选、添加元数据、生成报告
- 📐 高级格式化 -标注、表格、TOC、美人鱼图、LaTeX数学
- 🔧 保险库维护 -健康分析、查找重复项、自动化清理
- 🔄 交叉注释分析 -智能比较、合并、拆分笔记
核心能力
- 🤖 AI驱动的笔记创建 -让Amp为您创建结构化笔记
- 📝 代码段库 -自动保存带有语法高亮显示的代码
- 🧠 知识图谱 -通过自动链接构建相互关联的笔记
- 📊 主题摘要 -保存Amp对话以供将来参考
- 🔍 保险库搜索 -按内容、标签、元数据、正则表达式搜索笔记
- 🏷️ 采用智能标签 -自动分类和组织
- 🔗 加注使相互参照 -自动链接相关笔记
- 📈 分析 -保险库统计数据、健康报告、见解
- 💾 导出所有内容 -PDF、HTML、JSON、CSV、Markdown捆绑包
🚀 快速开始
先决条件
安装
-
克隆存储库:
git clone https://github.com/Kynlos/Obsidian-MCP.git cd Obsidian-MCP -
安装依赖项:
npm install -
运行安装向导:
npm run setup安装向导将:
- 提示您输入黑曜石金库路径
- 创建一个
.env配置文件 - 为您的平台(Windows/macOS/Linux)自动配置Amp
-
重新启动放大器
-
测试一下:
npm test或者在Amp中:
You: "Create a note in Obsidian called 'Test' with content 'Hello from Amp!'"
⚙️ 配置
工作区相对保险库(新!)
默认情况下,Vault是在您的 当前工作区目录 -不需要硬编码路径!
# Optional: Override defaults
VAULTS_BASE_PATH=/path/to/your/vaults/folder
OBSIDIAN_VAULT_PATH=/path/to/your/default/vault
自动设置(推荐)
运行安装向导以自动配置所有内容:
npm run setup
手动设置
-
复制
.env.example到.env:cp .env.example .env -
通过编辑配置文件配置Amp:
- 窗户:
%APPDATA%\Amp\mcp-config.json - macOS/Linux:
~/.config/amp/mcp-config.json
添加此配置:
{ "mcpServers": { "obsidian": { "command": "node", "args": ["/absolute/path/to/Obsidian-MCP/index.js"] } } } - 窗户:
-
重新启动放大器
🛠️ 可用工具
黑曜石MCP提供 121强大的工具 分为14类:
🎨 Canvas集成(6个工具)
创建和操作黑曜石画布文件(基于JSON的视觉板)。
| 工具 | 说明 |
|---|---|
create_canvas |
创建新的画布JSON文件 |
add_card_to_canvas |
将文本/注释/媒体卡添加到画布 |
add_connection_to_canvas |
用线/箭头连接卡 |
create_canvas_group |
将卡片分组在一起 |
read_canvas |
解析并读取画布结构 |
update_canvas_card |
修改现有画布卡 |
📊 数据视图查询执行(3个工具)
在vault上执行类似数据库的查询(简化实现)。
| 工具 | 说明 |
|---|---|
execute_dataview_query |
运行Dataview DQL查询并返回结果 |
create_dataview_codeblock |
将数据视图查询块插入注释中 |
validate_dataview_query |
检查查询语法是否有效 |
🌐 图形分析(5个工具)
以编程方式分析你的知识网络。
| 工具 | 说明 |
|---|---|
generate_graph_data |
从vault链接(节点/边)构建图形结构 |
find_note_clusters |
识别相关注释组 |
calculate_note_centrality |
查找最相关/最重要的笔记 |
get_shortest_path |
查找两个笔记之间的链接路径 |
find_isolated_notes |
连接很少/没有连接的注释 |
🔗 高级URI生成(4个工具)
创建黑曜石://深度链接以实现自动化和外部集成。
| 工具 | 说明 |
|---|---|
generate_obsidian_uri |
创建黑曜石://用于深度链接的URI |
create_workspace_uri |
生成URI以打开工作区 |
create_append_uri |
生成URI以将文本附加到注释中 |
create_search_uri |
生成URI以搜索保险库 |
📎 附件和媒体管理(5个工具)
管理vault中的媒体文件和附件。
| 工具 | 说明 |
|---|---|
list_attachments |
列出vault中的所有媒体文件 |
attach_file |
将外部文件复制到vault附件文件夹中 |
delete_attachment |
删除附件文件 |
find_orphaned_attachments |
查找未使用的媒体文件 |
get_attachment_references |
查找哪些笔记使用附件 |
🔍 高级搜索和替换(4个工具)
强大的搜索和重构工具。
| 工具 | 说明 |
|---|---|
regex_search_and_replace |
在vault中查找并替换为正则表达式 |
search_in_frontmatter |
专门搜索YAML frontmatter |
search_by_link_type |
查找特定的链接模式(wiki与markdown) |
multi_file_replace |
跨多个笔记批量查找/替换 |
🏷️ 增强型元数据/Frontmaster(6个工具)
高级YAML frontmatter操作。
| 工具 | 说明 |
|---|---|
update_frontmatter_field |
编辑特定的YAML字段而不重写注释 |
batch_update_metadata |
跨多个笔记更新属性 |
validate_frontmatter_schema |
根据架构检查frontmatter |
list_all_properties |
获取vault中的所有唯一属性密钥 |
rename_property_globally |
重命名所有笔记中的属性 |
get_property_values |
列出属性的所有值 |
📚 结构化内容模板(5个工具)
使用预格式化的结构创建常见的笔记类型。
| 工具 | 说明 |
|---|---|
create_from_template_with_prompts |
带变量替换的模板 |
create_book_note |
结构化书籍/文学笔记 |
create_person_note |
人员/联系人备注结构 |
create_meeting_note |
带有议程/行动项目的会议记录 |
create_project_note |
项目规划说明结构 |
✅ 增强的任务管理(5个工具)
超越基本TODO列表的高级任务数据管理。
| 工具 | 说明 |
|---|---|
get_tasks_by_criteria |
按状态、日期、优先级、标签筛选任务 |
move_task_between_notes |
将任务重新定位到不同的音符 |
add_task_metadata |
为任务添加截止日期、优先级和标签 |
create_task_report |
生成任务摘要/报告 |
find_blocked_tasks |
等待依赖关系的任务 |
📐 高级Markdown格式化(6个工具)
自动化繁琐的格式化任务。
| 工具 | 说明 |
|---|---|
convert_to_callout |
将文本包裹在详图索引块中 |
create_markdown_table |
以编程方式生成表 |
add_table_of_contents |
从标题生成目录 |
create_mermaid_diagram |
从数据生成Mermaid图 |
create_math_block |
添加LaTeX数学块 |
standardize_formatting |
修复标记格式不一致的问题 |
🔧 保险库维护(5个工具)
保持你的保险库健康有序。
| 工具 | 说明 |
|---|---|
find_duplicate_notes |
检测相似/重复内容 |
find_empty_notes |
列出没有内容的笔记 |
find_large_notes |
超过大小阈值的笔记 |
analyze_vault_health |
总体保险库统计数据/问题 |
cleanup_broken_references |
删除/修复损坏的链接 |
🔄 交叉注释分析(5个工具)
比较、重构和重新组织笔记。
| 工具 | 说明 |
|---|---|
compare_notes |
区分两个音符 |
find_similar_notes |
内容相似性分析 |
track_note_changes |
比较随时间变化的笔记版本 |
merge_notes_enhanced |
智能合并选项 |
split_note_by_headings |
把大钞分成小钞 |
📝 核心笔记创建(4个工具)
| 工具 | 说明 |
|---|---|
save_code_snippet |
使用语法高亮显示和元数据保存代码 |
save_thread_summary |
保存带有关键见解的AI对话摘要 |
save_knowledge_note |
使用标签创建常识笔记 |
create_daily_note |
使用可选的自定义模板创建每日笔记 |
✏️ 核心笔记管理(5个工具)
| 工具 | 说明 |
|---|---|
read_note |
阅读笔记的全部内容 |
update_note |
更新注释内容(默认情况下保留元数据) |
delete_note |
从vault中删除注释 |
append_to_note |
将内容附加到现有注释的末尾 |
rename_note |
重命名笔记文件 |
💡 用法示例
创建画布
You: "Create a canvas called 'Project Planning' and add cards for Frontend, Backend, and Database"
执行数据视图查询
You: "Show me all notes tagged with 'python' created this month"
生成黑曜石URI
You: "Create a link I can use to open my Daily Note from outside Obsidian"
分析保险库结构
You: "Show me the most connected notes in my vault and find any isolated notes"
创建结构化笔记
You: "Create a book note for 'The Pragmatic Programmer' by Andy Hunt and Dave Thomas"
高级格式化
You: "Create a Mermaid flowchart showing the authentication process and add it to my Security note"
🔧 可用命令
| 命令 | 描述 |
|---|---|
npm install |
安装依赖项 |
npm run setup |
运行交互式安装向导 |
npm test |
测试配置 |
npm start |
启动MCP服务器(用于调试) |
🧪 测试
验证您的设置是否正常工作:
npm test
这将检查:
.env文件存在并且有效- 黑曜石拱顶路径可访问
- 放大器配置正确
- 所有依赖项均已安装
- Node.js版本兼容
📊 版本历史记录
- v4.0.0 (2025-11-13) - 重大更新:添加了59个新工具(画布、数据视图、图形分析、URI等等!)
- v3.1.0 -导出功能(PDF、HTML、JSON、CSV)
- v3.0.0 -模板系统和高级搜索
- v2.0.0版本 -任务管理和分析
- v1.0.0 -首次发布
🎯 平台支持
此MCP适用于:
- ✅ 视窗 (10, 11)
- ✅ macOS (10.15+)
- ✅ Linux (Ubuntu、Debian、Fedora等)
自动配置路径:
- 窗户:
%APPDATA%\Amp\mcp-config.json - macOS/Linux:
~/.config/amp/mcp-config.json
📚 文档
🤝 贡献
欢迎投稿!请阅读我们的 贡献指南 了解详情。
📄 许可证
此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。
🔗 链接
- 存储库: https://github.com/Kynlos/Obsidian-MCP
- 放大器: https://ampcode.com/
- 黑曜石: https://obsidian.md/
- MCP规范: https://modelcontextprotocol.io/
🙏 致谢
- Kynlo 用于创建原始黑曜石MCP服务器
- 源代码图 为了 安培
- 黑曜石 令人惊叹的笔记应用程序团队
由以下材料制成❤️ Amp和黑曜石社区
⭐ 如果你觉得这个仓库有用,就把它标上!