第十八章:最佳实践建议
💡 本章提供 MiniClaw 的最佳实践建议,帮助用户更好地使用和扩展。
18.1 使用建议
18.1.1 首次运行引导
┌─────────────────────────────────────────────────────────────────────┐
│ 首次运行引导 │
├─────────────────────────────────────────────────────────────────────┤
│ │
│ 首次启动 MiniClaw 时的建议流程: │
│ ┌─────────────────────────────────────────────────────────────┐ │
│ │ │ │
│ │ 步骤 1:配置 MCP 客户端 │ │
│ │ ┌─────────────────────────────────────────────────────┐ │ │
│ │ │ // 添加到 MCP 客户端配置 │ │ │
│ │ │ { │ │ │
│ │ │ "mcpServers": { │ │ │
│ │ │ "miniclaw": { │ │ │
│ │ │ "command": "npx", │ │ │
│ │ │ "args": ["-y", "github:8421bit/miniclaw"] │ │ │
│ │ │ } │ │ │
│ │ │ } │ │ │
│ │ │ } │ │ │
│ │ └─────────────────────────────────────────────────────┘ │ │
│ │ │ │
│ │ 步骤 2:启动首次对话 │ │
│ │ ┌─────────────────────────────────────────────────────┐ │ │
│ │ │ 用户:你好,请介绍一下你自己 │ │ │
│ │ │ │ │ │
│ │ │ Agent:🦞 你好!我是 Claw... │ │ │
│ │ └─────────────────────────────────────────────────────┘ │ │
│ │ │ │
│ │ 步骤 3:完成觉醒访谈(如果触发 BOOTSTRAP.md) │ │
│ │ ┌─────────────────────────────────────────────────────┐ │ │
│ │ │ Agent:让我了解一下你... │ │ │
│ │ │ • 你希望我怎么称呼你? │ │ │
│ │ │ • 你主要使用什么编程语言? │ │ │
│ │ │ • 你有什么特别的工作习惯? │ │ │
│ │ └─────────────────────────────────────────────────────┘ │ │
│ │ │ │
│ │ 步骤 4:开始正常使用 │ │
│ │ │ │
│ └─────────────────────────────────────────────────────────────┘ │
│ │
└─────────────────────────────────────────────────────────────────────┘
18.1.2 日常使用模式
┌─────────────────────────────────────────────────────────────────────┐
│ 日常使用模式 │
├─────────────────────────────────────────────────────────────────────┤
│ │
│ 推荐的日常使用模式: │
│ ┌─────────────────────────────────────────────────────────────┐ │
│ │ │ │
│ │ 🌅 早间模式(morning) │ │
│ │ ┌─────────────────────────────────────────────────────┐ │ │
│ │ │ • 使用 miniclaw_briefing 获取每日简报 │ │ │
│ │ │ • 回顾昨天的进度和待办事项 │ │ │
│ │ │ • 规划今天的工作重点 │ │ │
│ │ └─────────────────────────────────────────────────────┘ │ │
│ │ │ │
│ │ 💼 工作模式(work) │ │
│ │ ┌─────────────────────────────────────────────────────┐ │ │
│ │ │ • 正常对话和任务执行 │ │ │
│ │ │ • 使用 miniclaw_note 记录重要信息 │ │ │
│ │ │ • 让 Agent 记住你的偏好 │ │ │
│ │ └─────────────────────────────────────────────────────┘ │ │
│ │ │ │
│ │ 🌙 晚间模式(evening) │ │
│ │ ┌─────────────────────────────────────────────────────┐ │ │
│ │ │ • 使用 miniclaw_growup 整理记忆 │ │ │
│ │ │ • 回顾今天的工作成果 │ │ │
│ │ │ • 让 Agent 总结经验教训 │ │ │
│ │ └─────────────────────────────────────────────────────┘ │ │
│ │ │ │
│ └─────────────────────────────────────────────────────────────┘ │
│ │
│ 常用命令示例: │
│ ┌─────────────────────────────────────────────────────────────┐ │
│ │ • "记住我喜欢简洁的回复" │ │
│ │ • "记住这个项目使用 TypeScript" │ │
│ │ • "整理一下今天的记忆" │ │
│ │ • "查看我的用户画像" │ │
│ │ • "检查系统状态" │ │
│ └─────────────────────────────────────────────────────────────┘ │
│ │
└─────────────────────────────────────────────────────────────────────┘
18.1.3 记忆管理建议
┌─────────────────────────────────────────────────────────────────────┐
│ 记忆管理建议 │
├─────────────────────────────────────────────────────────────────────┤
│ │
│ 记忆分类建议: │
│ ┌─────────────────────────────────────────────────────────────┐ │
│ │ │ │
│ │ ✅ 应该记录的内容: │ │
│ │ ┌─────────────────────────────────────────────────────┐ │ │
│ │ │ • 用户偏好(喜欢简洁、讨厌冗长) │ │ │
│ │ │ • 项目特定信息(技术栈、命名规范) │ │ │
│ │ │ • 重要决策(为什么选择这个方案) │ │ │
│ │ │ • 经验教训(踩过的坑) │ │ │
│ │ │ • 实体信息(团队成员、项目关系) │ │ │
│ │ └─────────────────────────────────────────────────────┘ │ │
│ │ │ │
│ │ ❌ 不应记录的内容: │ │
│ │ ┌─────────────────────────────────────────────────────┐ │ │
│ │ │ • 临时性信息(今天的天气) │ │ │
│ │ │ • 敏感信息(密码、密钥) │ │ │
│ │ │ • 过于详细的操作步骤 │ │ │
│ │ │ • 重复性信息 │ │ │
│ │ └─────────────────────────────────────────────────────┘ │ │
│ │ │ │
│ └─────────────────────────────────────────────────────────────┘ │
│ │
│ 记忆维护建议: │
│ ┌─────────────────────────────────────────────────────────────┐ │
│ │ │ │
│ │ 定期检查 MEMORY.md: │ │
│ │ • 删除过时的信息 │ │
│ │ • 合并重复的内容 │ │
│ │ • 更新变化的信息 │ │
│ │ │ │
│ │ 定期检查 USER.md: │ │
│ │ • 更新偏好设置 │ │
│ │ • 添加新的反模式 │ │
│ │ • 调整交互风格 │ │
│ │ │ │
│ └─────────────────────────────────────────────────────────────┘ │
│ │
└─────────────────────────────────────────────────────────────────────┘
18.2 开发建议
18.2.1 自定义 Agent 性格
┌─────────────────────────────────────────────────────────────────────┐
│ 自定义 Agent 性格 │
├─────────────────────────────────────────────────────────────────────┤
│ │
│ 通过修改 SOUL.md 自定义性格: │
│ ┌─────────────────────────────────────────────────────────────┐ │
│ │ --- │ │
│ │ read_when: │ │
│ │ - workspace bootstrap │ │
│ │ --- │ │
│ │ │ │
│ │ # 🎭 核心真理 │ │
│ │ │ │
│ │ ## 帮助性 │ │
│ │ 我的首要目标是帮助用户解决问题。 │ │
│ │ 我会主动提供解决方案,而不是等待指示。 │ │
│ │ │ │
│ │ ## 有主见 │ │
│ │ 我有自己的观点和偏好。 │ │
│ │ 当我认为有更好的方式时,我会说出来。 │ │
│ │ │ │
│ │ ## 足智多谋 │ │
│ │ 我会利用所有可用资源解决问题。 │ │
│ │ 我会记住过去的经验并应用它们。 │ │
│ │ │ │
│ │ # 🎨 回复风格 │ │
│ │ │ │
│ │ • 简洁明了,避免冗长 │ │
│ │ • 使用代码块展示技术内容 │ │
│ │ • 适当使用 emoji 增加亲和力 │ │
│ │ │ │
│ └─────────────────────────────────────────────────────────────┘ │
│ │
│ 性格调整建议: │
│ ┌─────────────────────────────────────────────────────────────┐ │
│ │ • 保持核心真理不变(帮助性、有主见、足智多谋) │ │
│ │ • 调整回复风格以适应用户偏好 │ │
│ │ • 添加特定领域的专业知识 │ │
│ │ • 定义边界和限制 │ │
│ └─────────────────────────────────────────────────────────────┘ │
│ │
└─────────────────────────────────────────────────────────────────────┘
18.2.2 创建自定义技能
┌─────────────────────────────────────────────────────────────────────┐
│ 创建自定义技能 │
├─────────────────────────────────────────────────────────────────────┤
│ │
│ 技能创建最佳实践: │
│ ┌─────────────────────────────────────────────────────────────┐ │
│ │ │ │
│ │ 1. 明确技能目标 │ │
│ │ • 技能要解决什么问题? │ │
│ │ • 技能的使用场景是什么? │ │
│ │ │ │
│ │ 2. 设计技能结构 │ │
│ │ • 需要哪些提示词? │ │
│ │ • 需要哪些工具? │ │
│ │ • 需要哪些参考资源? │ │
│ │ │ │
│ │ 3. 编写 SKILL.md │ │
│ │ • 清晰的描述 │ │
│ │ • 完整的元数据 │ │
│ │ • 详细的使用说明 │ │
│ │ │ │
│ │ 4. 测试和迭代 │ │
│ │ • 测试所有功能 │ │
│ │ • 收集反馈 │ │
│ │ • 持续改进 │ │
│ │ │ │
│ └─────────────────────────────────────────────────────────────┘ │
│ │
│ 示例:代码审查技能 │
│ ┌─────────────────────────────────────────────────────────────┐ │
│ │ --- │ │
│ │ name: code-review │ │
│ │ description: "代码审查辅助技能" │ │
│ │ prompts: │ │
│ │ - name: review_checklist │ │
│ │ description: "生成代码审查清单" │ │
│ │ - name: security_check │ │
│ │ description: "安全漏洞检查" │ │
│ │ tools: │ │
│ │ - name: analyze_code │ │
│ │ description: "分析代码质量" │ │
│ │ --- │ │
│ │ │ │
│ │ # Code Review Skill │ │
│ │ │ │
│ │ ## 功能 │ │
│ │ • 代码质量检查 │ │
│ │ • 安全漏洞扫描 │ │
│ │ • 最佳实践建议 │ │
│ │ │ │
│ │ ## 使用方法 │ │
│ │ 1. 调用 review_checklist 获取审查清单 │ │
│ │ 2. 调用 analyze_code 分析代码 │ │
│ │ 3. 根据结果进行改进 │ │
│ │ │ │
│ └─────────────────────────────────────────────────────────────┘ │
│ │
└─────────────────────────────────────────────────────────────────────┘
18.2.3 配置工作空间规则
┌─────────────────────────────────────────────────────────────────────┐
│ 配置工作空间规则 │
├─────────────────────────────────────────────────────────────────────┤
│ │
│ 通过 AGENTS.md 配置工作空间规则: │
│ ┌─────────────────────────────────────────────────────────────┐ │
│ │ --- │ │
│ │ read_when: │ │
│ │ - workspace bootstrap │ │
│ │ --- │ │
│ │ │ │
│ │ # 📋 工作空间章程 │ │
│ │ │ │
│ │ ## 每会话必读 │ │
│ │ • SOUL.md - 核心人格 │ │
│ │ • USER.md - 用户偏好 │ │
│ │ • TOOLS.md - 环境配置 │ │
│ │ │ │
│ │ ## 代码规范 │ │
│ │ • 使用 TypeScript 严格模式 │ │
│ │ • 遵循 ESLint 规则 │ │
│ │ • 编写单元测试 │ │
│ │ │ │
│ │ ## Git 规范 │ │
│ │ • 分支命名:feature/xxx, fix/xxx │ │
│ │ • 提交信息:feat: / fix: / docs: │ │
│ │ • PR 前必须通过测试 │ │
│ │ │ │
│ │ ## 禁止事项 │ │
│ │ • 不要直接修改 dist 目录 │ │
│ │ • 不要提交敏感信息 │ │
│ │ • 不要跳过代码审查 │ │
│ │ │ │
│ └─────────────────────────────────────────────────────────────┘ │
│ │
│ 规则配置建议: │
│ ┌─────────────────────────────────────────────────────────────┐ │
│ │ • 规则要具体明确 │ │
│ │ • 规则要可执行 │ │
│ │ • 规则要定期更新 │ │
│ │ • 规则要有优先级 │ │
│ └─────────────────────────────────────────────────────────────┘ │
│ │
└─────────────────────────────────────────────────────────────────────┘
18.3 安全建议
18.3.1 敏感信息处理
┌─────────────────────────────────────────────────────────────────────┐
│ 敏感信息处理 │
├─────────────────────────────────────────────────────────────────────┤
│ │
│ 敏感信息处理原则: │
│ ┌─────────────────────────────────────────────────────────────┐ │
│ │ │ │
│ │ ❌ 不要让 Agent 记住: │ │
│ │ ┌─────────────────────────────────────────────────────┐ │ │
│ │ │ • API 密钥和令牌 │ │ │
│ │ │ • 数据库密码 │ │ │
│ │ │ • 个人身份证号 │ │ │
│ │ │ • 银行卡信息 │ │ │
│ │ │ • 公司内部机密 │ │ │
│ │ └─────────────────────────────────────────────────────┘ │ │
│ │ │ │
│ │ ✅ 安全的替代方案: │ │
│ │ ┌─────────────────────────────────────────────────────┐ │ │
│ │ │ • 使用环境变量存储密钥 │ │ │
│ │ │ • 使用 .env 文件(不提交到 Git) │ │ │
│ │ │ • 使用密钥管理服务 │ │ │
│ │ │ • 脱敏后记录(如 sk-***...***) │ │ │
│ │ └─────────────────────────────────────────────────────┘ │ │
│ │ │ │
│ └─────────────────────────────────────────────────────────────┘ │
│ │
│ 如果不小心记录了敏感信息: │
│ ┌─────────────────────────────────────────────────────────────┐ │
│ │ 1. 立即从 MEMORY.md 和日志文件中删除 │ │
│ │ 2. 更换相关密钥/密码 │ │
│ │ 3. 检查是否有泄露风险 │ │
│ │ 4. 教育 Agent 不要记录此类信息 │ │
│ └─────────────────────────────────────────────────────────────┘ │
│ │
└─────────────────────────────────────────────────────────────────────┘
18.3.2 文件权限设置
┌─────────────────────────────────────────────────────────────────────┐
│ 文件权限设置 │
├─────────────────────────────────────────────────────────────────────┤
│ │
│ 推荐的文件权限设置: │
│ ┌─────────────────────────────────────────────────────────────┐ │
│ │ │ │
│ │ # 设置 MiniClaw 目录权限 │ │
│ │ chmod 700 ~/.miniclaw │ │
│ │ │ │
│ │ # 设置敏感文件权限 │ │
│ │ chmod 600 ~/.miniclaw/MEMORY.md │ │
│ │ chmod 600 ~/.miniclaw/USER.md │ │
│ │ chmod 600 ~/.miniclaw/entities.json │ │
│ │ │ │
│ │ # 设置日志目录权限 │ │
│ │ chmod 700 ~/.miniclaw/memory │ │
│ │ │ │
│ └─────────────────────────────────────────────────────────────┘ │
│ │
│ 权限说明: │
│ ┌─────────────────────────────────────────────────────────────┐ │
│ │ 700 = rwx------ → 仅所有者可读写执行 │ │
│ │ 600 = rw------- → 仅所有者可读写 │ │
│ │ 644 = rw-r--r-- → 所有者可写,其他人只读 │ │
│ └─────────────────────────────────────────────────────────────┘ │
│ │
└─────────────────────────────────────────────────────────────────────┘
本章小结
┌─────────────────────────────────────────────────────────────────────┐
│ 第十八章 核心要点 │
├─────────────────────────────────────────────────────────────────────┤
│ │
│ 🚀 使用建议 │
│ • 首次运行:配置 → 启动 → 觉醒访谈 → 正常使用 │
│ • 日常模式:早间简报 → 工作对话 → 晚间整理 │
│ • 记忆管理:记录偏好/决策,避免临时/敏感信息 │
│ │
│ 🛠️ 开发建议 │
│ • 自定义性格:修改 SOUL.md │
│ • 创建技能:明确目标 → 设计结构 → 编写 → 测试 │
│ • 工作空间规则:配置 AGENTS.md │
│ │
│ 🔒 安全建议 │
│ • 不记录敏感信息(密钥、密码等) │
│ • 使用环境变量存储密钥 │
│ • 设置适当的文件权限 │
│ │
└─────────────────────────────────────────────────────────────────────┘
下一章:常见问题与解决方案 →