🚀 克劳迪欧指南
本指南将详细介绍克劳迪欧项目的安装、配置、使用以及开发相关内容，帮助你快速上手并解决常见问题。
🚀 快速开始
📦 安装指南
安装依赖
使用Bun进行依赖安装：
bun add ts-mdx @types/node zod
启动服务
在项目根目录下创建并运行以下脚本：
#!/bin/bash
BUN_PATH=./node_modules/.bun/bun
$BUN_PATH run ./src/server.ts
🔧 配置环境变量
编辑.env文件，添加如下内容：
OBSIDIAN_VAULT_DIR=/path/to/obsidian/vault
💻 使用示例
Obsidian功能
基础用法
以下是Obsidian功能的基础使用示例：
写入笔记
write_note({
"path": "Projects/新项目",
"content": "# 新项目\n\n此处记录项目细节。",
"append": true
})
删除笔记
delete_note({
"path": "Projects/旧项目"
})
读取笔记
read_notes({
"paths": ["Projects/新项目", "Daily/2025-04-12"]
})
搜索笔记
search_notes({
"query": "项目"
})
📚 详细文档
MCP开发指南
创建新MCP文件
在/ts/src/目录下创建新的.ts文件，可参考现有文件如obsidian.ts。
定义参数模式
使用Zod定义输入参数：
const MyToolArgsSchema = z.object({
param1: z.string().describe("参数1描述"),
param2: z.number().optional().describe("可选参数2")
});
实现工具功能
在server.setRequestHandler()中实现具体逻辑。
更新配置文件
修改claude_desktop_config.template.json和cursor_config.template.json，添加新MCP配置：
"my-new-tool": {
"command": "{{BUN_PATH}}",
"args": ["运行", "{{PROJECT_ROOT}}/ts/src/my-new-tool.ts", "{{SOME_PARAMETER}}"]
}
添加环境变量
根据需要在.env文件中添加新的环境变量，并更新README文档说明。
❓ 常见问题解决
- ⚠️ 验证命令行输出：确认是否有错误信息。
- ⚠️ 检查
.env文件路径：确保其位置正确。 - ⚠️ 确认Bun运行正常：通过执行简单命令测试。
- ⚠️ Obsidian功能确认vault路径：保证
OBSIDIAN_VAULT_DIR设置无误。 - ⚠️ 交互式安装问题处理：尝试使用
make setup进行传统安装。
🌟 开发理念
本项目仅使用Bun作为包管理工具，不支持npm、yarn等其他工具。所有安装和运行操作均需通过bun命令执行。