深度解析:人类与 AI Agent 协作的仓库级规则与文档管线)
【免费下载链接】rocketride-serverHigh-performance AI pipeline engine with a C core and 50 Python-extensible nodes. Build, debug, and scale LLM workflows with 13 model providers, 8 vector databases, and agent orchestration, all from your IDE. Includes VS Code extension, TypeScript/Python SDKs, and Docker deployment.项目地址https://gitcode.com/gh_mirrors/ro/rocketride-server点击查看免费下载导读本文以 RocketRideAparavi数据工具链仓库根目录的 AGENTS.md 为骨架系统拆解这套面向人类与 AI 编码助手双读者的仓库治理方案它如何通过一张任务路由表把开发者导航到正确的文档、如何用统一命令面./builder覆盖构建/测试/文档校验、如何在代码规范与文档规则层面保证 C 引擎、Python/TypeScript 双 SDK、50 节点与 VS Code 扩展组成的 monorepo 长期可维护。读完本文你将掌握该仓库先读文档再写代码的完整工作流、节点 README 的生成式契约以及 agent 文档包docs.zip从打包、下发到验收测试的整条管线。AGENTS.md 的定位仓库级规则的唯一事实来源AGENTS.md开宗明义它是面向在本仓库中工作的人类和 Agent 的贡献者指南同时是仓库级规则的单一事实来源single source of truth——根目录的.claude/CLAUDE.md与.cursorrules等助手指针文件都指向它避免多份规范文件互相漂移。这一设计在仓库中落地为实体文件docs/agents/context/stubs/下保存了各 AI 编码助手的指针模板CLAUDE.md、cursor.mdc、claude-code.md、copilot-instructions.md、windsurf.md、AGENTS.md由安装器写入工作区详见 stubs 目录。docs/agents/README.md进一步说明context/会被原样安装进工作区的.rocketride/docs/stubs/则存放各助手的指针文件。也就是说AGENTS.md这类规范文件不仅是给人读的更是一套可随 SDK/扩展自动下发到任意工作区的机器可读知识。Monorepo 全景四层技术栈的仓库结构AGENTS.md 的 Overview 段给出仓库的最小编码monorepo 构成层次路径职责C 引擎packages/server/高性能处理引擎核心Python SDK 与节点packages/client-python/、nodes/50 可扩展节点的 Python 生态TypeScript SDK 与 VS Code 扩展packages/client-typescript/、apps/vscode/语言侧客户端与 IDE 内开发体验支撑包与构建编排各packages/*、apps/*-ui./builder封装构建与测试编排根目录的builder是一个薄壳脚本内容仅数行定位自身目录后exec node $DIR/scripts/build.js --overlay-root$DIR $——真正的编排逻辑集中在 scripts/build.js 与其下的 scripts/lib/ 任务运行器。工作区由 pnpm-workspace.yaml、package.jsonNode ≥ 20、pnpm ≥ 10与 pyproject.tomlPython 3.10共同定义。任务路由表先读对文档再写代码AGENTS.md 的核心实用段落是一张任务 → 该读什么的路由表全部路径为仓库相对路径。这是新人人类或 Agent进入仓库的第一张地图写作任何代码前都必须先读对应文档任务必读文档使用 RocketRide / 写集成代码先读 docs/agents/context/ROCKETRIDE_README.md再读该目录下其余ROCKETRIDE_*文件构建或编辑节点docs/development/nodes/readme-schema.mdREADME 契约、docs/development/nodes/services-schema.mdservices.json 契约、docs/development/nodes/index.md节点是什么各节点 README 即目录测试节点docs/development/nodes/testing.md客户端SDK文档docs/development/clients/readme-schema.md源文件在docs/public/name/MCP 面docs/public/mcp/引擎内部docs/development/engine/index.mdWebSocket5565协议docs/public/product/connect/websocket/崩溃上报 / minidumpdocs/development/engine/crash-reporting.mdShell 应用docs/public/product/guides/apps/index.mdapp API、docs/development/apps/index.mdmonorepo 搭建为已发布 app 写文档仅apps/app/内部README.md、docs/、assets/例外VS Codedocs/docusaurus/apps/vscode/与 App Builderdocs/public/product/guides/apps/app-builder.mdBuilder / hooksdocs/development/builder/reference.md跑构建、docs/development/builder/authoring.md写 tasks.js、docs/development/builder/pre-commit-hooks.md产品文档站点主干docs/public/product/这张表的意义在于消除二义性同样是写文档节点文档、客户端文档、app 内文档、站点文档各有明确的归属目录与契约文件杜绝了贡献者各写各的导致的文档碎片化。常用命令一个./builder覆盖全生命周期AGENTS.md 给出了仓库的命令面清单以下逐条展开./builder build # 构建 EVERYTHING全局命令展开为每个模块的 :build —— server、shell、所有 UI、SDK、vscode ./builder test # 全部测试 python -m pytest path # 直接跑 Python 测试 python -m ruff check path # Python lint格式化用 ruff format npx tsc --noEmit # TypeScript 类型检查文档校验类命令同样是日常流程的一部分# 文档校验 ./builder docs:validate # node README client-doc schema 校验也包含在 docs:test 内 python3 scripts/validate-node-readme.py node-dir # 校验单个节点--all nodes/src/nodes 校验全部节点 python3 scripts/validate-client-docs.py # 客户端文档一致性校验 node scripts/build.js docs:check # 导出漂移门禁CI 强制 ./builder docs:build # 暂存stage文档站点从源码看docs:validate对应的 Python 校验器存在于 scripts/validate-node-readme.py节点 README 契约与 scripts/validate-client-docs.py客户端文档 paritydocs:check通过 scripts/build.js 执行是 CI 强制门禁用于捕获包 README 与源文档漂移。仓库根部的 lefthook.yml 配合 scripts/verify-action-pins.mjs 在提交前做 action 固定校验check:action-pins脚本形成本地提交钩子 CI 双保险。代码规范三套语言、三条纪律AGENTS.md 的 Conventions 段按技术栈细分规范是所有提交的硬约束提交信息Conventional Commits形如feat(scope):、fix(scope):、chore(scope):。分支命名feat/RR-ticket-short-description、fix/RR-ticket-...PR 基线分支为develop。Python3.10单引号ruff 负责 lint/format。TypeScript制表符缩进单引号分号结尾。VS Code 扩展专属铁律错误一律用Callout.call()包裹禁止裸try/catch抛错用AppError禁止裸Error日志走logger.*禁止console.log例外文档站点主题组件docs/docusaurus按设计豁免。这些约定与仓库根部的 eslint.config.mjs、tsconfig.json 及 VS Code 扩展源码apps/vscode/src/ 下的 providers、shared 等模块一致属于写进规范、也写进工具链的双重约束——lint 与类型检查即规范的可执行版本。文档规则谁住在哪里由谁生成文档规则是 AGENTS.md 篇幅最重的部分核心思想是**文档是变更的一部分而不是善后工作**任何改动若触及公开契约必须在同一次变更中更新对应文档且不设独立 docs 仓库。各类型文档的归属如下产品文档快速上手、概念、集成、示例、评估、术语表、故障排查、云、自托管→ docs/public/product/公开 TypeScript SDK 签名→ docs/public/typescript/指南生成的参考文档在packages/client-typescript/docs/reference/勿手改由client-typescript:docs-generate重新生成公开 Python SDK 签名→ docs/public/python/参考文档为生成产物MCP 协议面→ docs/public/mcp/WebSocket5565/ 引擎协议面→ docs/public/product/connect/websocket/.pipeschema定义于 packages/client-typescript/src/client/types/pipeline.ts→ 参考文档重新生成至/reference/pipeline-reference生成产物勿手改VS Code 扩展面→ 站点页面在 docs/docusaurus/apps/vscode/marketplace README 在 apps/vscode/README.md其他 appapps/app/→ 文档留在 app 目录内部永不进入站点App Builder 与 VS Code 是仅有的两个例外且不再新增例外贡献者文档搭建、builder、引擎内部、节点编写、hooks→ docs/development/第三方集成指南→ docs/public/product/connect/面向 Agent 的文档ROCKETRIDE_*→ docs/agents/context/由./builder client-docs:agent打包进/client/docs分发包。节点文档唯一的例外即规则节点是唯一的例外节点文档与节点源码同仓存放于nodes/src/nodes/name/README.md遵循 docs/development/nodes/readme-schema.md 的 README 契约。其中ROCKETRIDE:GENERATED:PARAMS区域由nodes:docs-generate维护——禁止手改校验方式为python3 scripts/validate-node-readme.py node-dir从仓库看nodes/src/nodes/ 下 685 个 Python 文件对应 50 节点每个节点目录都有配套 README构成一份节点目录即目录的可浏览目录。包 README生成式提交拷贝包级 README 一律是生成式提交拷贝编辑源文档 docs/public/typescript/README.md、docs/public/python/README.md、docs/public/n8n/README.md、docs/public/chat-widget/README.md及 MCP 源文档docs/public/mcp/stdio/README.md后运行./builder docs:export严禁直接编辑packages/client-typescript/README.md、packages/client-python/README.md、packages/n8n-nodes/README.md、packages/chat-widget/README.md。CI 的./builder docs:check专门捕获这类漂移。VS Code 的 marketplace README 归属扩展自身apps/vscode/README.mdVSIX 构建时会把其中的图片链接重写为绝对 URL。规则末尾明确纯文案修改与不触及公开契约的内部重构不需要更新文档——门禁只针对公开契约面避免无谓的提交噪音。Agent 文档体系从context/打包到task-battery验收AGENTS.md 将面向 AI 助手的文档ROCKETRIDE_*指向 docs/agents/context/这套体系在 docs/agents/README.md 中有完整定义是仓库让 Agent 可自治的关键基础设施context/被 VS Code 扩展与rocketride init原样安装进工作区.rocketride/docs/。client-docs:agent任务docs/agents/scripts/tasks.js把根部的ROCKETRIDE_*.md当前共 11 个README、CLI、CONCEPTS、PIPELINES、APPS、INTEGRATIONS、OBSERVABILITY、UI_COMPONENTS、COMPONENT_REFERENCE、python_API、typescript_API与stubs/一起打成docs.zip由引擎在GET /client/docs对外服务。context/内的一切都会随客户端下发之外的不会——这是文档打包的边界线。skills/人工精选的管道构建技能不进分发包仅通过显式技能安装加入。task-battery.mdcontext/的验收测试——256 道用户会交给编码 Agent 的真实任务按类别分组并带最新覆盖率评分。改动文档后应让只加载了context/的 Agent跑对应类别跑不通的项目即文档缺口。从 task-battery.md 看最近一次评分第三轮2026-08-20基线为 9.0/2307 分测试以CLAUDE.mdstub 加十个ROCKETRIDE_*文件为唯一知识源禁止读取源码从而保证文档自足。打包实现细节docs/agents/scripts/tasks.js也值得关注任务先清空暂存目录、拷贝*.md与stubs/*再对全部内容计算contentHash写入manifest.json——这个 hash 正是 CLI 的rocketride init与 VS Code 扩展安装文档时的变更戳仅当内容变化时才重新压缩docs.zip保证产物字节级稳定最后syncDir到dist/server/static/clients/docs并登记进发布归档。由于每个客户端构建client-typescript、client-python、client-mcp与 vscode 构建都把client-docs:agent列为步骤服务端分发的包永远与客户端构建时源码树一致不会出现冻结在客户端包里的过期拷贝。实操工作流一次合规变更的完整链路综合 AGENTS.md 的规则一次合规变更的典型链路为查路由表按任务类型定位必读文档例如改节点 → 先读 docs/development/nodes/index.md 与 readme-schema.md。改代码遵守 Conventions 段的分支/提交/语言规范VS Code 扩展代码走Callout/AppError/logger三件套。同步文档若触及公开契约在同一变更内更新归属文档节点 README 只改非生成区包 README 只改docs/public/name/源文档后跑./builder docs:export。本地校验./builder docs:validate、python3 scripts/validate-node-readme.py node-dir、npx tsc --noEmit等按需执行。提交pre-commit hookslefthook.yml兜底PR 基线指向develop。CI 复核./builder docs:check作为导出漂移门禁最终把关。结语RocketRide 仓库的AGENTS.md并非一纸随意的贡献须知而是一套面向双读者人类与 AI Agent的仓库宪法任务路由表消除该看哪篇的歧义./builder统一命令面把构建/测试/文档校验收敛为可组合的 action 图文档规则用生成式拷贝 CI 漂移门禁解决文档与代码脱节这一 monorepo 通病docs/agents/体系则把 Agent 需要的知识打包成随客户端下发的docs.zip并用 256 道验收题持续度量文档自足度。对于任何想给 AI 编码助手喂规范的多语言仓库这份文件都是一个值得对照参考的范本。赞分享【免费下载链接】rocketride-serverHigh-performance AI pipeline engine with a C core and 50 Python-extensible nodes. Build, debug, and scale LLM workflows with 13 model providers, 8 vector databases, and agent orchestration, all from your IDE. Includes VS Code extension, TypeScript/Python SDKs, and Docker deployment.项目地址https://gitcode.com/gh_mirrors/ro/rocketride-server点击查看免费下载相关推荐rust-analyzer 仓库 AI 协作与贡献工程指南AGENTS.md 深度解读rust analyzer 仓库 AI 协作与贡献工程指南AGENTS.md 深度解读 本文以 rust analyzer 仓库根目录的 AGENTS.md开发工具Rook 仓库的 AI 协作开发指南AGENTS.md 规则解读与贡献工作流实战Rook 仓库的 AI 协作开发指南AGENTS.md 规则解读与贡献工作流实战 导读 AGENTS.md https://link.gitcode.com/云原生存储容器编排运维AzerothCore 的 AI Agent 协作规范全解AGENTS.md 规则体系与仓库源码级解析AzerothCore 的 AI Agent 协作规范全解AGENTS.md 规则体系与仓库源码级解析 AzerothCore 是一个基于 C 的 MMO游戏开发后端创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考