关于 ai-context
为 AI 编码助手编写和维护结构化仓库文档的指南，区分始终加载的简要上下文与按需读取的详细技能说明。
主要功能
- 01AGENTS.md 与 CLAUDE.md 指南
- 02按需技能组织方式
- 03包与目录级上下文
- 04文档维护规则
适用场景
- 01为编码助手设置仓库上下文
- 02创建或修订任务专属技能
- 03保持 Agent 文档简洁且及时更新
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/ai-context确认已加载。
详细介绍
AI 上下文文档
如何编写和维护 AI 编码助手所消费的结构化文档。
文件层级
AGENTS.md # Root context — always loaded by agents
CLAUDE.md # Required for Claude Code (loads AGENTS.md)
.github/skills/<topic>/SKILL.md # On-demand detailed context
packages/<name>/AGENTS.md # Package-specific context
<any-folder>/AGENTS.md # Folder-specific context
根文件
AGENTS.md
每次交互时始终加载。保持精简以节省 token。
必须包含：
- 一行项目描述
- 基本命令（运行、测试、构建）
- 仓库结构概览（仅顶层目录）
- 链接到每个
SKILL.md的技能索引表 - 常见任务的关键入口点
必须不包含：
- 详细说明（放到技能中）
- 超过一行的代码示例
- 与技能重复的内容
CLAUDE.md
必需，因为 Claude Code 不会原生加载 AGENTS.md。它将 Claude Code 接入同一套上下文系统。内容：
Read [AGENTS.md](AGENTS.md) before starting any task.
## Skills
Load these for detailed context on specific topics:
| Skill | When to use |
|-------|-------------|
| [<name>](.github/skills/<name>/SKILL.md) | <description> |
与 AGENTS.md 中的技能表保持同步。
技能
创建技能
- 创建
.github/skills/<topic>/SKILL.md - 添加包含
name和description的 YAML frontmatter - 在
AGENTS.md和CLAUDE.md的技能表中各添加一条条目
SKILL.md 格式
---
name: <topic>
description: <when an agent should load this — be specific about triggers>
---
# <Title>
<One-line summary.>
## <Sections organized by task>
编写指南
- Frontmatter
description：将其写成一个触发条件——什么任务或问题应导致 Agent 加载此技能 - 简洁：用表格代替散文，用代码片段代替解释
- 具体：文件路径、命令名称、函数签名——而非模糊描述
- 不重复：如果信息存在于另一个技能中，引用它而不是重复
- 可操作的结构：按 Agent 需要做什么来组织，而不是按架构
包与文件夹上下文
在以下情况下，在包或文件夹内添加 AGENTS.md：
- 该目录有不明显的约定，Agent 总是搞错
- 有根文档未覆盖的本地命令、模式或坑点
保持这些文件非常短——几行上下文通常就足够了。
何时更新
| 触发条件 | 操作 |
|---|---|
| Agent 反复询问某个主题 | 创建新技能 |
| 尽管有文档，Agent 仍出错 | 完善相关技能 |
| 新包/目录有独特模式 | 添加本地 AGENTS.md |
| 架构或工具变更 | 更新受影响的技能 |
| 技能变得过大 | 拆分为多个技能 |
| 技能表变更 | 同时更新 AGENTS.md 和 CLAUDE.md |
原则
- Token 预算：根文件保持小巧；细节放入技能
- 按需加载：技能仅在任务相关时才会被读取
- 活的文档：模式变化时更新——过时的文档比没有更糟
- 跨平台：
AGENTS.md+.github/skills/是共享约定；CLAUDE.md桥接不会原生加载AGENTS.md的 Claude Code
评论
支持 Markdown