项目说明构建器

写一份对得起它在每次请求中所花 token 的说明文件。

项目说明描述着你们团队的工作方式。文件在浏览器里生成，绝不上传。

看看它在长会话里的代价

关于 项目说明构建器

项目说明文件在每次会话开始时都会被读一遍，所以只要文件还在，其中的每一行都会在每一次请求里被付费。仅这一个事实，就决定了什么该写、什么不该写。凡是读代码就能发现的——语言、框架、目录结构——都是在向一个本来就看得见的读者重复。真正值得占位置的恰恰相反：那个需要加参数的测试命令、那个会让构建失败的 Node 版本、新人一定会猜错的约定、已经害某人赔上一个下午的那件事。这个构建器就是按这些类别组织的，会估算这份文件的代价，并标出那些正在向仓库讲述它自己的行。

功能特性

• 按"该写什么"引导的分节，而不是一张白纸
• 实时的 token 估算——是每次请求的代价，不是一次性的
• 标出重复了代码本就展示的内容的行
• 标出改变不了任何事的空洞劝诫
• 文件长到会被略读时发出警告
• 没有可用于精简的小标题时给出提示
• 空的分节直接省略，而不是写成空白
• 下载为 CLAUDE.md

如何使用 项目说明构建器

1. 写上项目名称
2. 只填你确有非显而易见内容可说的分节
3. 留意 token 估算随之增长
4. 读完警告，下载文件

示例

输入

This project is a React app.

输出

Warning: the language and framework are visible from the manifest

每一行的试金石：读者能在十秒内自己查到吗？

常见错误与故障排除

• 文件被标为过大。 — 把只是偶尔相关的内容挪到单独的文档里，让会话在需要时去读。说明文件是给"永远成立"的内容用的。
• 我想保留的一行被标成"可自行发现"。 — 如果它确实起作用，忽略这个警告。这项检查是提醒你自问"读者会不会反正也能查到"，不是一条规则。
• 加了说明却什么都没变。 — 具体且可核对的说明远比笼统的有用。"使用 components/ui 里的基础组件"胜过"写干净的代码"。
• 这该叫 CLAUDE.md 还是别的名字？ — 内容是一样的。用你的工具会读取的名字保存即可；结构和"什么该进来"的分寸不变。

常见问题

说明文件里到底该写什么？

那些从代码里发现不了、否则一定会被猜错的东西：需要加参数的命令、会让构建失败的版本、任何单个文件里都看不出的约定，以及明确的禁止事项。其余都是在向一个本来就会读的读者重复。

应该写多长？

短到还有人会读。估算会随你输入显示；超过几千 token 就值得问一问哪些行真的永远相关，其余可以放进按需读取的文档里。

为什么"写干净的代码"会被标出来？

因为它什么都改变不了。笼统的劝诫在每次请求里花掉 token，却不提供任何判断依据；具体的约定——逻辑放哪里、用哪些基础组件——才提供。

"每次请求都付费"这件事重要吗？

这正是要精简这份文件的原因。一页说明一次是小钱，摊到几千次请求就是实实在在的开销，所以估算就放在正文旁边，而不是藏起来。

能把密钥写进去吗？

不能——它每次会话都会被读进上下文，而且通常会进仓库。把凭据留在环境里，说明中若需提及，只用名字引用。

相关工具

• 技能构建器 — 编写 SKILL.md，边输入边检查 frontmatter。
• 子代理构建器 — 生成子代理定义文件，含工具与模型设置。
• 斜杠命令构建器 — 构建自定义命令，带参数与工具白名单。
• 上下文窗口规划 — 在提示、工具、历史与回复之间分配上下文窗口。
• 提示缓存规划 — 重排请求的各块，让可缓存前缀尽可能长。
• 系统提示检查器 — 找出自相矛盾、无效指令与未替换的占位符。

更多AI 与智能体工具

• 技能构建器 — 编写 SKILL.md，边输入边检查 frontmatter。
• 技能检查器 — 粘贴 SKILL.md，看清是什么让它无法与任务匹配。
• 子代理构建器 — 生成子代理定义文件，含工具与模型设置。
• 斜杠命令构建器 — 构建自定义命令，带参数与工具白名单。
• 插件清单构建器 — 生成 plugin.json，并查看它所预设的目录结构。
• 钩子构建器 — 构建 settings.json 钩子，找出永远不会触发的匹配式。
• 权限规则测试器 — 用真实命令测试允许、询问与拒绝规则。
• MCP 服务器配置 — 为 stdio、HTTP 或 SSE 生成 MCP 服务器条目。
• MCP 工具模式构建器 — 定义工具并得到 JSON Schema，严格模式一并校验。
• 工具模式校验器 — 粘贴工具定义，查清它为何被拒绝或被错误调用。
• 提示模板填充 — 把一条提示展开到整张表格，并看清缺了哪些值。
• 系统提示检查器 — 找出自相矛盾、无效指令与未替换的占位符。
• 提示差异比较 — 逐词比较两个提示版本，并给出 token 差额。
• 少样本示例构建器 — 把输入输出对转成带标签、JSON 或对话格式的示例。
• XML 提示分节构建器 — 用内容无法越出的标签包裹提示的各个部分。
• JSONL 查看与校验 — 逐行读取、筛选并检查 JSONL 文件。
• 对话记录转换 — 把消息数组转成可读记录，也能转回去。
• 微调数据集校验 — 检查 chat 格式 JSONL，找出会中断训练的错误。
• SSE 流查看器 — 粘贴原始流式响应，取回正文、工具调用与用量。
• 上下文窗口规划 — 在提示、工具、历史与回复之间分配上下文窗口。
• 提示缓存规划 — 重排请求的各块，让可缓存前缀尽可能长。
• 文本切分 — 把文档切成有重叠的片段，只在真正的边界处断开。
• 代理循环成本估算 — 逐轮估算成本，计入重发的历史与缓存。
• 批量请求构建器 — 把表格转成批量任务，每条请求都有唯一 id。

查看全部AI 与智能体工具 · 全部工具