mcpField
B
braindump

braindump

github.com/mohganjiAgent 工作流437 次安装37 周前更新
代码仓库

关于 braindump

braindump 是一项技能,可将本地笔记作为长期上下文保存,并在对话之间检索。它指导 Agent 记录有持久价值的项目资料,并在相关任务开始前查找笔记。

主要功能

  1. 01按标题和标签保存上下文笔记
  2. 02搜索、列出和检索已保存笔记
  3. 03按类别整理笔记
  4. 04以 JSON 格式输出供程序处理
  5. 05将笔记保存在本地 Markdown 文件中

适用场景

  1. 01实现集成前查找 API 资料
  2. 02保存项目决策及其理由
  3. 03为后续任务检索用户偏好

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/mohganji/braindump --skill braindump

安装后在 Claude Code 中输入/braindump确认已加载。

附带文件scripts/install.sh

详细介绍

braindump - Agent 记忆

可搜索的本地笔记,可在不同对话间持久保留。悄然捕捉上下文信息,将其作为长期记忆保存,供当前会话结束后继续使用。

手动触发:

  • “use your brain” 或 “remember anything about...” — 执行任务前,在 braindump 中搜索相关上下文
  • “braindump this” 或 “save this to memory” — 保存当前上下文或信息,以供日后检索

设置

首次使用前,请确认 CLI 已安装。如果在 PATH 中找不到 braindump,请安装:

curl -fsSL https://raw.githubusercontent.com/MohGanji/braindump/main/install.sh | bash

也可以运行捆绑的安装程序:

bash "SKILL_DIR/scripts/install.sh"

安装后,使用 braindump --version 验证。

命令

# Save
braindump add <category> --title "..." --content "..." --tags "tag1,tag2"

# Retrieve
braindump search "query"
braindump list [category]
braindump get <category> "pattern"

# Manage
braindump update <id> --content "..."
braindump append <id> --content "additional info"
braindump delete <id>
braindump categories
braindump tags

程序化使用时,请添加 --format json。

自主行为

何时存储(主动)

捕捉对话结束后可能丢失的信息:

  • 业务需求、用例、用户故事
  • 有用的 URL 和变量(API 文档、端点、环境配置)
  • API 规范、字段映射、数据转换
  • 系统约束、假设、排除项
  • 特定集成的行为、特殊情况和注意事项
  • 领域术语、别名、缩写
  • 附有理由的技术决策
  • 已知问题、局限性、变通方法
  • 配置要求、阈值、默认值
  • 用户偏好和项目惯例
  • 用户分享的外部上下文(规范、文档)
  • 已解决的 bug 及其解决方案
何时检索(主动)

在可能受益于先前上下文的任务开始时,搜索 braindump:

  • 在此前讨论过的领域中实现功能之前
  • 用户提及过去对话中的内容时
  • 使用此前记录过的 API、集成或系统时
  • 做出可能已有记录的架构决策之前
工作流
  1. 存储前:先搜索现有内容——如果找到,则更新或追加;如果没有,则添加新笔记
  2. 开始工作前:搜索可能有助于当前任务的相关上下文
  3. 尽可能将相关信息合并到现有类别或标题下
  4. 除非新信息与现有内容矛盾,否则保留现有内容
  5. 着重保存长期有效的知识,而非对话过程中的临时内容

类别与结构

类别代表相互关联的领域:集成、系统功能、独立模块或逻辑边界。根据上下文直观地选择类别——适合时使用现有类别,必要时创建新类别。

标题应使用便于搜索、能有效缩小上下文范围的关键词。

内容应简洁且信息密集。列表请使用项目符号。仅在有助于阐明行为时包含代码示例。

不应捕捉的内容

  • 临时调试会话或短暂状态
  • 缺乏上下文的文件路径或代码片段
  • 文档中已有的一般编程知识
  • 关于对话本身的元评论
  • 频繁变化且不具长期价值的信息

存储

~/.braindump/ — 带有 YAML frontmatter 的纯文本 Markdown 文件。每个类别对应一个目录。使用 FTS5 SQLite 索引实现快速搜索。

评论

支持 Markdown