mcpField
C
cs-note

cs-note

github.com/codestableAgent 工作流1.1k1.1k 次安装10 周前更新
代码仓库

关于 cs-note

`cs-note` 是 CodeStable 技能,用于把每次会话都需了解的简短项目事实写入 `.codestable/attention.md`。它按固定分节查重追加,并将较长或临时信息引导至其他技能。

主要功能

  1. 01检查 CodeStable 启动注意事项
  2. 02按固定分节归类事实
  3. 03追加前检索重复内容
  4. 04限制条目长度并提示软上限
  5. 05将不适合的信息转交其他技能

适用场景

  1. 01记录每次会话都需知晓的构建事实
  2. 02为仓库补建缺失的 attention 文件骨架
  3. 03发现重复条目时判断更新或另记

安装

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

$npx skills add https://github.com/codestable/codestable --skill cs-note

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

详细介绍

来自项目 README

cs-note

启动必读

开始任何判断或动作前,先检查 .codestable/attention.md:存在就读取;缺 .codestable/ 就提示先运行 cs-onboard;只有 attention.md 缺失时,本技能可以先创建固定分节骨架再写入。不要用 AGENTS.md / CLAUDE.md 等外部入口代替它。

cs-keep 产出独立 markdown 文件到 .codestable/compound/,通过 grep 检索被读到;.codestable/attention.md 是 CodeStable 技能启动时的强制必读上下文。这两类信息归宿不同——本技能专管后者:把"短、稳、每次都要知道"的碎片追加到 attention 文件里。

不替代 cs-keep,是另一个入口。


Spec

data Frequency = EverySession | TaskSpecific
data Lifetime = LongTerm | Temporary
data NoteFact = NoteFact
  { lineCount :: Int
  , frequency :: Frequency
  , lifetime :: Lifetime
  , needsDecisionRecord :: Bool
  }
data NoteOutcome
  = WriteAttention Section
  | RouteToKeep | RouteToWorkSpec | RouteToDomain
  | NeedsHuman Reason

selectNote :: NoteFact -> NoteOutcome
selectNote n
  | needsDecisionRecord n               = RouteToDomain
  | lifetime n == Temporary             = RouteToWorkSpec
  | lineCount n > 2                     = RouteToKeep
  | frequency n /= EverySession         = RouteToKeep
  | otherwise                           = WriteAttention (classifySection n)

信息不足时只问:“这条以后是不是每次会话都要让 AI 知道?”不是则 RouteToKeep。


目标文件

目标文件固定为 .codestable/attention.md。AGENTS.md / CLAUDE.md / .cursorrules 等外部 AI 工具入口不是 CodeStable attention 的替代源。

  • .codestable/ 不存在 → 本仓库还没接入 CodeStable,先提示用户运行 cs-onboard
  • .codestable/attention.md 不存在 → 视为骨架缺失,先创建最小骨架再写入
  • AGENTS.md / CLAUDE.md 即使存在也不作为目标文件;需要同步外部入口时走 cs-docs-neat

attention.md 是 CodeStable 自己的启动注意事项入口,价值来自所有 CodeStable 技能都明确要求读取它,而不是依赖外部工具的自动注入。


固定分节结构

为了防止文件膨胀成另一个胖文件,分节写死一组(不在列表里的不开新节):

## 项目碎片知识

<!-- cs-note managed: 用 cs-note 维护,新条目按下面分节追加 -->

### 编译与构建

### 运行与本地起服务

### 测试

### 命令与脚本陷阱

### 路径与目录约定

### 环境变量与凭证

### 其他

规则:

  • 新条目去对应分节末尾追加,每条一行(最多两行)
  • 没有合适的分节 → 进"其他"。"其他"超过 5 条就停下来和用户讨论是否新增固定分节(不要默默加节)
  • 分节为空时整段保留,不删(让 AI 看到这一节是有意义的)
  • 注释行 <!-- cs-note managed --> 是本技能的识别锚——找不到就在文件末尾插入整块结构
  • 整段长度软上限 ~150 行——超过提示用户:"碎片知识太多了,挑几条沉到 cs-keep 里?"

流程

1. 判定该不该进

按上面"判据"表对一遍。任一项不过 → 引导到对应别的技能,本轮结束。

2. 确认 attention 文件

检查 .codestable/attention.md。缺 .codestable/ 就停止并提示先 cs-onboard;只缺 attention.md 就创建本技能的固定分节骨架。

3. 找位置:分节归类 + 查重
  • 读 .codestable/attention.md,找 <!-- cs-note managed --> 锚定位
  • 找不到锚 → 在文件末尾追加整块"项目碎片知识"骨架
  • 在"项目碎片知识"段内 grep 关键词查重——已有相似条目时不另起一条,问用户"是更新已有那条还是确实是另一条"
  • 选好分节,没有合适分节进"其他"
4. 写一条进去

每条格式:

- {一句话事实 + 必要时一句话原因}

例:

- 编译前要先 `pnpm run gen`,否则 schema 类型对不上
- 别用 `npm install`,项目锁文件是 yarn berry 的
- src/legacy/ 是 2023 前的老代码,改之前先和 @ldz 确认

写完报告路径与新增条目后退出。用户明确要求修改时再更新;不设置写后确认 checkpoint。不主动连写多条——一次一条,避免顺手把没拍板的也塞进去。

5. 触发软上限检查

写完看一眼"项目碎片知识"段总行数:

  • ≥150 行 → 提示用户挑几条沉到 cs-keep
  • "其他"分节 ≥5 条 → 提示用户讨论是否新增固定分节

只是提示,不替用户决定。


主动推荐时机

不要每次都问。只在两个明确信号触发时推一句:

  1. 用户在对话中说出明显属于碎片知识的事实——"哦对这个项目要先 X 才能 Y"、"我们这个用 Z 不用 W"——推:"这条要不要 cs-note 一下?以后 AI 每次都能看到。"
  2. AI 自己刚踩了一个一句话能讲清的项目特殊设置(编译失败 / 命令不对 / 路径找错)——修复后推:"这个坑是项目通用的吗?是的话 cs-note 记一笔,下次会话直接知道。"

用户说"不用了"立刻跳过,不重复推。


Failure Behavior

.codestable/ 缺失、事实是否每次必读仍不清楚、与已有条目重复但无法判断更新关系时返回 NeedsHuman。不属于 attention 的内容返回对应 RouteToKeep / RouteToWorkSpec / RouteToDomain,并在当前 run 传递原始事实;目标 skill 不可加载时停下报告,不在本技能复制其流程。


容易踩的坑

  • 把详细背景 / 多步骤指南塞进 attention.md——超过两行就该走 cs-keep
  • 写到 AGENTS.md / CLAUDE.md——它们不是 CodeStable attention 的替代源;外部入口同步走 cs-docs-neat
  • 默默新增分节——分节是写死的,新增要先和用户讨论
  • 看到一条就连带把其他几条也写进去——一次一条
  • 写"短期状态"(本周在做 X / 这个 sprint 的目标)——会过期但没人删,慢慢变误导
  • 不查重就追加——同一条事实被记 3 次后 AI 反而搞不清哪条是准的

退出条件

  • 条目已写入固定分节且最多两行,写前已查重。
  • 写入内容来自用户明确事实,不含临时状态、长解释或 ADR。
  • 最终回复只报告路径与条目;没有悬空的写后确认。

评论

支持 Markdown