使用说明
奥马奇·麦克普
一个Claude Code插件，它公开了 奥马奇手册 作为本地MCP服务器。直接在Claude对话中提供对手册所有43个部分的可搜索、缓存访问。
作者 阿尔多·W·查孔(@Aldochaconc)
它做什么
- 在本地获取并缓存Omarchy手册（无重复的网络调用）
- 公开5个MCP工具，用于从Claude内部查询文档
- 支持按需刷新以获取文档更新
- 启用所有缓存部分的全文搜索
安装
/plugin marketplace add /path/to/omarchy-mcp
/plugin install omarchy-mcp@omarchy-mcp-dev
重新启动克劳德代码。然后预加载完整的手动缓存（一次性）：
fetch_all_sections
MCP工具
list_sections
列出Omarchy手册的所有43个部分及其slug和缓存状态。
没有参数。
输出示例：
- **Welcome to Omarchy** — `welcome-to-omarchy` (cached 2026-03-07)
- **Hotkeys** — `hotkeys` (not cached)
...
read_section
阅读特定章节的全部内容。
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
slug |
string | yes | 段塞（例如。 hotkeys, neovim).使用 list_sections 寻找蛞蝓。 |
refresh |
boolean | no | 即使缓存，也从实时网站重新获取。违约： false. |
例子：
read_section { "slug": "hotkeys" }
read_section { "slug": "neovim", "refresh": true }
search_docs
在所有缓存部分进行全文搜索。最多返回5场比赛，并按相关性排名摘录。
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
query |
string | yes | 要搜索的关键字或短语。 |
注： 仅搜索本地缓存中已有的部分。跑 fetch_all_sections 首先是全面覆盖。
例子：
search_docs { "query": "clipboard" }
search_docs { "query": "fingerprint auth" }
fetch_all_sections
从实时网站获取并缓存所有43个部分。运行一次以构建本地索引，或使用 refresh: true 当文档更新时。
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
refresh |
boolean | no | 即使已经缓存，也要重新获取所有部分。违约： false. |
例子：
fetch_all_sections {}
fetch_all_sections { "refresh": true }
cache_status
显示缓存了哪些部分以及上次获取这些部分的时间。
没有参数。
输出示例：
# Cache Status
43/43 sections cached
Last full fetch: 2026-03-07
- [x] Welcome to Omarchy — last fetched 2026-03-07
- [x] Hotkeys — last fetched 2026-03-07
...
缓存
内容存储在 server/.cache/ 在插件目录中。每个部分都是一个JSON文件：
server/.cache/
├── index.json # Metadata index
├── hotkeys.json
├── neovim.json
└── ...
缓存路径可以通过以下方式覆盖 OMARCHY_CACHE_DIR 环境变量。
发展
cd server
npm install
npm run build # Compile TypeScript → dist/
npm start # Run the server directly
要迭代插件：
/plugin uninstall omarchy-mcp@omarchy-mcp-dev
# make changes, then:
npm run build
/plugin install omarchy-mcp@omarchy-mcp-dev
# restart Claude Code
手册章节
| 蛞蝓 | 标题 |
|---|---|
welcome-to-omarchy |
欢迎来到奥马奇 |
the-basics |
基础知识 |
getting-started |
入门指南 |
navigation |
导航 |
themes |
主题 |
extra-themes |
额外主题 |
making-your-own-theme |
制作自己的主题 |
universal-clipboard |
通用剪贴板 |
hotkeys |
热键 |
the-applications |
应用程序 |
terminal |
航站楼 |
neovim 我不知道。 |
|
ai |
AI |
development-tools |
开发工具 |
shell-tools |
壳牌工具 |
shell-functions |
外壳功能 |
tuis TUIs。 |
|
guis GUI |
|
commercial |
商业 |
filling-out-pdfs |
填写PDF |
web-apps |
Web应用程序 |
gaming |
游戏 |
windows-vm |
Windows虚拟机 |
other-packages |
其他套餐 |
configuration |
配置 |
updates |
更新 |
dotfiles |
点文件 |
monitors |
监视器 |
keyboard-mouse-trackpad |
键盘、鼠标、触控板 |
system-sleep |
系统睡眠 |
fingerprint-fido2-authentication |
指纹和Fido2身份验证 |
fonts |
字体 |
backgrounds |
背景 |
prompt |
提示 |
common-tweaks |
常见调整 |
manual-installation |
手动安装 |
mac-support |
Mac支持 |
troubleshooting |
故障排除 |
faq |
常见问题解答 |
system-snapshots |
系统快照 |
security |
安全 |
omarchy-on |
奥马奇在 |
the-rest |
其余的 |
许可证
麻省理工学院
