LifeOS MCP服务器
最后更新时间:2025-11-05
用于管理LifeOS黑曜石保险库的模型上下文协议(MCP)服务器。为AI助手提供结构化访问,以创建、阅读和搜索笔记,同时保持YAML合规性和组织标准。
特性
- 符合YAML的笔记创建:自动遵循LifeOS YAML规则
- 自定义YAML规则集成:参考您自己的YAML frontmatter指南
- PARA方法组织:尊重项目/领域/资源/档案结构
- 模板系统:与11+LifeOS模板(餐厅、文章、人物等)集成
- 搜索引擎:具有相关性评分和上下文提取的全文搜索
- 黑曜石融合:直接在黑曜石中打开笔记的可点击链接
- 日常笔记管理:创建和管理每日日记账分录
- 分析仪表板:具有视觉洞察力的遥测(⚠️ 目前有缺陷,不建议使用)
- 通用工具:将6个搜索工具合并为1个,具有自动路由功能
- iCloud同步弹性:macOS上文件操作的自动重试逻辑
- 向后兼容:所有11个遗留工具别名通过专用处理程序模块(MCP-97)和混合调度回退继续使用弃用警告
平台支持
✅ 支持的平台:
- macOS -初级开发平台
- Linux -全面支持(生产部署)
- WSL2 -Windows用户通过Unix子系统
MCP客户端兼容性:
- 克劳德桌面(macOS、Linux、Windows通过WSL2)
- 光标IDE(macOS、Linux、Windows通过WSL2)
- Raycast(仅限macOS)
- Unix系统上的自定义MCP客户端
❌ 不支持:
- 本机Windows (cmd.exe、PowerShell)
windows用户:该项目正式支持Unix平台。为了与Windows兼容,请安装 WSL2 一个完整的Unix环境。所有功能在WSL2中无缝工作。看 WSL2安装指南 了解详细的安装说明。
依据:参见 ADR-007:仅支持Unix平台 对于完整的决策背景。
快速开始
自动设置(推荐)
# Clone and run automated setup
git clone https://github.com/shayonpal/mcp-for-lifeos.git
cd mcp-for-lifeos
chmod +x scripts/setup.sh
./scripts/setup.sh安装脚本将安装依赖项、生成配置并构建应用程序。
手动安装
npm install
npm run build📖 有关详细的部署说明,请参阅 部署指导
配置
- 复制
src/config.example.ts到src/config.ts - 更新保管库路径以匹配您的黑曜石保管库位置
- 为您的特定联系人自定义PEOPLE_MAPPINGS
- 可选的:设置
yamlRulesPath参考您的YAML frontmatter指南
export const LIFEOS_CONFIG: LifeOSConfig = {
vaultPath: '/path/to/your/obsidian/vault',
templatesPath: '/path/to/your/obsidian/vault/Templates',
yamlRulesPath: '/path/to/your/vault/YAML Rules.md', // Optional
// ... other paths
};刀具模式配置
使用控制注册哪些MCP工具 TOOL_MODE 环境变量:
consolidated-only(默认):仅现代整合工具(13个工具)-干净、集中的工具列表consolidated-with-aliases:整合工具和传统工具(24个工具)-最大兼容性legacy-only:仅限遗留工具(21个工具)-用于遗留集成
默认行为 (无需配置):
- ✅ 现代整合工具(
search,create_note,list) - ✅ 核心实用程序(10个始终可用的工具)
- ❌ 隐藏旧工具别名
工具名称更改(MCP-60):
create_note_smart已重命名为create_note(智能功能现在是默认设置)- 遗产
create_note_smart别名可用consolidated-with-aliases模式
恢复旧工具,在MCP客户端配置中设置:
{
"mcpServers": {
"lifeos": {
"command": "node",
"args": ["/path/to/build/index.js"],
"env": {
"VAULT_PATH": "/path/to/vault",
"TOOL_MODE": "consolidated-with-aliases"
}
}
}
}📖 有关完整的配置选项,请参阅 配置指南
可用工具
推荐:综合工具
search -通用搜索,所有搜索操作都有自动路由
- 支持模式:自动、高级、快速、content_type、最近、模式
- 自然语言查询(例如,“魁北克烧烤餐厅”)
- 自动代币预算管理
create_note -具有自动模板检测功能的智能笔记创建
- 自动从标题/内容中检测模板
- 处理YAML验证和文件夹放置
list -文件夹、每日笔记、模板、YAML属性的通用列表
- 列表类型自动检测
- 支持简洁详细的格式
核心业务
注释管理:
create_note-使用YAML frontmatter和模板创建笔记read_note-阅读现有笔记edit_note-使用frontmatter合并编辑笔记get_daily_note-获取或创建每日笔记move_items-移动笔记和文件夹rename_note-原子注释重命名,包括vault范围的链接更新、模拟运行预览和崩溃恢复insert_content-在特定位置插入内容
公用设施:
diagnose_vault-诊断保险库问题get_server_version-获取服务器版本和功能get_yaml_rules-检索自定义YAML规则
搜索:
advanced_search-使用元数据过滤器进行全文搜索list_yaml_properties-发现YAML属性list_yaml_property_values-分析房产价值
📖 有关完整的工具文档,请参阅 工具API参考
客户端集成
克劳德桌面
添加到您的Claude Desktop配置中:
{
"mcpServers": {
"lifeos": {
"command": "node",
"args": ["/absolute/path/to/mcp-for-lifeos/dist/src/index.js"],
"env": {
"ENABLE_WEB_INTERFACE": "false"
}
}
}
}光线投射
使用 @lifeos-mcp 在AI聊天和命令中提到服务器,用于快速搜索保险库和创建笔记。
光标IDE
在代理模式下直接访问vault上下文,以便在编码时研究现有知识。
📖 有关完整的集成指南,请参阅 集成指南
模板系统
服务器包括与11+个模板的智能模板集成:
- 餐厅, 文章, 人, 每日的, 参考
- 医学, 应用, 书, 地方, fleeting 翻译为中文是:短暂的, 模拟
模板会自动处理Templater语法,并将注释放置在正确的PARA文件夹中。
# Auto-detect template from title
create_note title: "Pizza Palace" # → restaurant template
# Explicit template
create_note title: "My Article" template: "article"📖 有关模板系统的详细信息,请参阅 模板指南
分析仪表板
⚠️ 重要提示:分析仪表板目前存在错误,不应使用。
分析系统存在影响数据收集和可视化的已知问题。正在努力解决这些问题。在此之前,我们建议禁用分析:
{
"mcpServers": {
"lifeos": {
"env": {
"DISABLE_USAGE_ANALYTICS": "true"
}
}
}
}状态: 分析收集和仪表板暂时不可靠。请谨慎使用或完全禁用。
📊 有关完整的分析文档,请参阅 分析/README.md
文档
指南
- 📖 部署指导 -完整的设置和部署说明
- ⚙️ 配置指南 -详细的配置选项
- 🔧 模板指南 -模板系统和定制
- 🔌 集成指南 -客户端集成(Claude Desktop、Raycast、Cursor)
- 🐛 故障排除指南 -常见问题和解决方案
- 📱 Raycast集成 -Raycast特定设置
- 💻 光标集成 -游标IDE特定设置
API 参考
- 🔧 工具API参考 -完整的工具文档,包括参数和示例
分析
- 📊 分析仪表板 -分析配置和见解
发展
# Development mode with auto-reload
npm run dev
# Build for production
npm run build
# Run tests
npm test
# Type checking
npm run typecheck测试
# All tests
npm test
# Unit tests only
npm run test:unit
# Integration tests only
npm run test:integration版本控制
服务器遵循语义版本控制(MAJOR.MINOR.PATCH):
- 重大:API更改不兼容
- 次要的:新功能(向后兼容)
- 补丁:Bug修复(向后兼容)
所有API响应都包含用于兼容性检查的版本元数据。
YAML合规性
服务器自动执行LifeOS YAML规则:
- 用途
sourceURL字段(非url或URL) - 保持位置格式:
Country [CODE](例如。,Canada [CA]) - 从不编辑自动管理的字段(
date created,date modified) - 验证YAML语法并提供错误报告
- 支持灵活的标记格式:字符串、数组或YAML列表
文件命名规范
Notes使用保留可读性的自然文件命名:
- 蜜饯:空格、标点符号、数字、括号
- 移除:方括号
[],科朗:,分号; - 示例书评:《权力的48条法则》→ “书评-权力的48条定律.md”
支持和贡献
- 🐛 问题:通过以下方式报告错误和请求功能
- 💬 讨论:加入存储库中的社区讨论
- 📖 文档:检查 docs/ 用于指南和参考
许可证
此项目根据GNU通用公共许可证v3.0获得许可。看 许可证.md 了解详情。
版权所有(C)2025 Shayon Pal\ 敏捷代码工作室 - https://agilecode.studio
