使用说明
Cortex
Your Obsidian vault, available to your AI coding tools — read, write, search, and organize notes from Claude Code, Codex, or OpenCode.
它做什么
Cortex让AI编码工具直接与你的黑曜石笔记一起工作。它经营着一家本地 主控程序 Obsidian内部的服务器,任何兼容的客户端都可以通过HTTP连接到该服务器——没有云服务,没有同步,也没有需要处理的配置文件。
快速开始
- 从以下位置安装 黑曜石社区插件 (搜索“Cortex”)
- 启用插件——服务器在端口上自动启动
27182 - 连接您的客户端:
克劳德代码
claude mcp add -s user --transport http cortex http://127.0.0.1:27182/mcp
法典
添加 .codex/config.toml 在您的项目中(或 ~/.codex/config.toml 全球):
[mcp_servers.cortex]
type = "remote"
url = "http://127.0.0.1:27182/mcp"
开源代码
添加到您的 opencode.json:
{
"mcp": {
"cortex": {
"type": "remote",
"url": "http://127.0.0.1:27182/mcp"
}
}
}
- 验证:让你的AI工具运行
list_folders--如果它返回vault的文件夹结构,则表示您已连接。
示例用法
连接后,只需用自然语言询问您的AI工具:
- “总结我本周的会议记录”
- “在Projects/my应用程序中创建一个注释,说明今天的架构决策”
- “在我的保险库中搜索有关身份验证的所有信息”
- “列出我使用过的所有标签以及使用频率”
可用工具
| 工具 | 说明 |
|---|---|
read_note |
通过笔记的vault路径读取笔记内容 |
write_note |
在给定路径上创建或覆盖注释 |
edit_note |
在注释中添加、预置或查找并替换 |
search_notes |
在vault中的笔记中进行全文搜索 |
list_notes |
列出笔记,可选择按文件夹筛选 |
get_note_metadata |
获取首页、标签、链接和标题 |
delete_note |
删除笔记(默认情况下移动到垃圾箱) |
list_tags |
列出vault中的所有标签及其频率 |
list_folders |
列出vault中的文件夹 |
连接项目
你可以告诉你的AI工具哪个黑曜石文件夹映射到当前项目。这样,当它创建或查找笔记时,它知道把它们放在哪里。
将代码段添加到项目根目录:
CLAUDE.md (克劳德代码)或 AGENTS.md (Codex、OpenCode):
## Cortex
- Cortex folder for this project: `Projects/my-app`
替换 Projects/my-app 使用vault文件夹路径。OpenCode检查 AGENTS.md 首先,然后回落到 CLAUDE.md.
配置
打开 设置→ 皮质 配置:
- 港口 --MCP服务器的HTTP端口(默认
27182,需要重新启动) - 自动启动 --启动Obsidian时启动服务器(默认打开)
故障排除
- 服务器未启动 --检查端口
27182已在使用中。如果需要,在设置中更改端口。 - 客户端无法连接 --确保Obsidian已打开并且服务器正在运行(检查状态栏图标)。
- 更改了端口 --更新客户端配置中的URL以匹配新端口。
支持
如果Cortex对你有用,考虑支持它的开发。
安全
- 绑定到
127.0.0.1仅--默认情况下无远程访问 - 流量停留在您的机器上
从源代码构建
npm install
npm run build
复制 main.js 和 manifest.json 进入你的保险库 .obsidian/plugins/cortex/.
