Hey AI README
一站式管理 AI 编码资源 —— 规则包 · 团队资源库 · MCP · Skills · SubAgents，让 Cursor / Copilot 写出更高质量的代码。
AI 编码助手的生成质量，取决于它能获取到多少项目上下文和工程规范。Hey AI README 把这件事产品化——通过规则包、指令模板、团队资源库和资产市场，让 AI 理解你的项目，遵循你的规范。
6 大核心能力
| 能力 |
说明 |
| 规则包管理 |
按语言/技术栈选择规则包，自动下发到 .cursor/rules/ |
| AI README 指令 |
基于代码事实快速生成项目上下文，下发到 .cursor/rules/ai-readme |
| 团队 AI 资源库 |
通过 Git 仓库统一管理和分发团队级规则、Skills、Agents |
| MCP 工具配置 |
发现并一键配置 MCP 工具，增强 AI 能力（仅 Cursor） |
| Skills 市场 |
浏览、搜索、一键安装社区 Skills |
| SubAgents 市场 |
浏览、搜索、一键安装社区 SubAgents |
使用方式
右键菜单（推荐）— 在资源管理器空白处右键，即可看到 AI README 子菜单，包含所有核心操作：
状态栏按钮 — 编辑器底部右侧的 AI README 按钮，点击直接打开管理中心。
快速开始
Step 1 — 右键 → AI README → 修改全局规则配置，选择你的项目类型规则包（支持多选）。
Step 2 — 同步完成后，项目中自动生成以下文件：
your-project/.cursor/
├── commands/ # AI README 指令（基于代码生成项目上下文）
│ ├── ai-readme.md
│ ├── ai-readme-workspace.md
│ ├── ai-readme.code-review.md
│ └── ai-readme.gen-rule.md
├── rules/
│ ├── std-common/ # 通用规则（始终下发）
│ └── std-nodejs/ # 语言规则（按选择下发）
└── ai-readme.json # 项目配置
规则包管理
为不同语言/技术栈的项目，提供开箱即用的 AI 编码规范。选择规则包后自动下发到 .cursor/rules/，让 AI 生成的代码符合组织级工程标准。
始终包含 std-common 通用基础规则，可叠加选择：
| 规则包 |
适用场景 |
std-common |
通用编码规范（始终下发） |
std-nodejs |
Node.js 后端项目 |
std-frontend |
Web 前端项目（Vue / React / TypeScript） |
std-java |
Java 后端项目 |
| ... |
更多规则包持续扩展中 |
在管理中心的「规则包」Tab 中，支持搜索、分类快捷筛选（全部 / 规范驱动 / 前端 / 后端 / 客户端 / 测试），点击卡片即可启用或禁用。
同步策略为覆盖同名文件（std-* 目录）。自定义规则建议放在独立目录，避免被更新覆盖。
AI README 指令
AI README 指令的核心作用是基于代码事实，快速生成一份项目基础上下文——让 AI 在开始工作前就能理解项目的技术栈、目录结构、模块关系和关键约定，而不是从零猜测。
指令下发到 .cursor/commands/，在 Cursor 中可直接调用：
| 指令文件 |
做什么 |
ai-readme.md |
扫描项目代码，生成 / 增量更新项目级 AI README 上下文文档 |
ai-readme-workspace.md |
面向多仓库项目群，生成跨仓库协作视角的上下文 |
ai-readme.code-review.md |
基于 Git Diff 生成结构化的 AI CodeReview 报告 |
ai-readme.gen-rule.md |
将需求 / 想法转换为 Cursor 规则文件（.mdc） |
指令随规则包一起下发，更新时自动覆盖。如需团队长期维护自定义指令，建议通过「团队 AI 资源库」统一管理。
团队 AI 资源库
团队将共享的规则、Skills、Agents 放到 Git 仓库中，成员一键同步到本地项目，或下发到本机全局。
两种作用域（都写入项目配置，团队 clone 即生效）
| 作用域 |
配置存储位置 |
同步目标目录 |
谁能用 |
项目（workspace，缺省） |
<工作区>/.cursor/ai-readme.json |
<工作区>/.cursor/ |
当前项目 |
全局（global） |
<工作区>/.cursor/ai-readme.json（同上） |
~/.cursor/（仅 skills/agents） |
本机所有项目；队友 clone 后自动同步 |
配置文件中通过 deployScope 字段标识。缺省视为 workspace。
设计要点：「全局」条目的配置项也写到 项目 .cursor/ai-readme.json，让团队成员 clone 仓库后扩展启动会自动把它们同步到本机的 ~/.cursor/，无需每个人重复手动添加。
兼容旧数据：历史上扩展把「全局」条目写到 ~/.cursor/ai-readme.json，新版仍可读取这些条目并参与同步；扩展激活时会弹一次性通知，引导用户复制到当前项目以便随仓库共享。
仓库目录映射
| 仓库目录 |
项目（workspace） |
全局（global） |
templates/ 或 rules/ |
.cursor/rules/<repoName>/ |
不同步 |
skills/ |
.cursor/skills/（合并） |
~/.cursor/skills/（合并） |
agents/ |
.cursor/agents/（合并） |
~/.cursor/agents/（合并） |
global-skills/ |
~/.cursor/skills/（合并） |
~/.cursor/skills/（合并） |
global-agents/ |
~/.cursor/agents/（合并） |
~/.cursor/agents/（合并） |
| 其它非隐藏顶层目录 |
.cursor/<dirName>/ |
不同步 |
global-skills/ 与 global-agents/ 是约定目录：无论 deployScope 如何，始终落到 ~/.cursor/，方便单仓库混合项目资源与全局资源。
在管理中心的「团队AI资源库」Tab 中，粘贴 Git 仓库地址（支持多个，换行或逗号分隔），通过「添加到项目」/「添加到全局」选择目标作用域。两个按钮都需要先在顶部选择一个工作区，配置都会写入该项目的 .cursor/ai-readme.json。
自动同步：
- 启动时同步当前工作区中所有条目；同一 Git URL 在多个项目里只会被克隆一次；
deployScope='global' 的条目无论从哪个项目读出，最终都落到 ~/.cursor/；- 每天凌晨 1 点自动更新；
- 历史
~/.cursor/ai-readme.json 中的遗留条目仍会被同步（向前兼容），建议通过启动迁移提示复制到当前项目，让团队同享。
MCP 工具发现与配置（仅 Cursor）
MCP（Model Context Protocol）为 AI 接入外部能力——提示词优化、文档查询、代码分析等。本插件提供统一的发现和一键配置体验。
在管理中心的「MCP」Tab 中，浏览可用的 MCP 工具，支持搜索筛选。点击启用后配置写入 ~/.cursor/mcp.json，重启 Cursor 即可生效。
内置推荐：
| 工具 |
能力 |
| Prompt Optimizer |
提示词优化，提升 AI 理解准确度 |
| Java Class Analyzer |
Java 类反编译与结构分析 |
| Context7 |
实时获取第三方库最新文档 |
| ... |
更多工具持续扩展 |
插件只管理自己创建的 MCP 配置项，不会修改或删除你手动添加的其它配置。
Skills 发现与安装
Skills 赋予 AI 特定领域的专业能力——TDD 工作流、代码评审规范、提示词优化等。
在管理中心的「Skills」Tab 中，浏览社区贡献的 Skills，按名称 / 描述 / 标签搜索，点击安装即可下载到 .cursor/skills/ 目录。
支持分页浏览、并行安装、安装量展示。
SubAgents 发现与安装
SubAgents 是可被 AI 调度的专业子代理——架构设计、E2E 测试、代码清理等。
在管理中心的「SubAgents」Tab 中，浏览社区贡献的 SubAgents，搜索并一键安装到 .cursor/agents/ 目录。
交互体验与 Skills Tab 一致，展示安装量、创建者、标签等信息。
常见问题
Q：看不到规则包同步入口？
请确认已打开工作区（workspace folder），规则包下发依赖项目根目录。
Q：团队AI资源库同步失败，提示"仓库中不存在 templates 目录"？
远端仓库根目录下必须有 templates/（或 rules/）目录，请在仓库中创建该目录并放入规则文件。
Q：MCP 功能为什么不可用？
MCP 配置仅在 Cursor 环境启用。在 VSCode 中使用时，MCP Tab 会显示环境检测提示。
Q：更新后我手动修改的规则被覆盖了？
std-* 目录采用覆盖写入策略。需手动维护的规则请放在独立目录，或通过「团队 AI 资源库」管理。
Q：Skills / SubAgents 安装到了哪里？
Skills 安装到 .cursor/skills/，SubAgents 安装到 .cursor/agents/。
Q：多工作区如何使用？
管理中心的规则包和团队资源库 Tab 顶部有工作区文件夹选择器，每个文件夹可独立配置。
