文档

项目上下文

管理代码库记忆文件,以及文档、策略和引用代理在工作前读取的内容。

智能体可以读取你的代码和代码库中的指令文件。上下文会将那些记忆文件与项目笔记、生成的上下文及引用内容整合在一起。

如需了解此处内容的设定依据,请阅读项目上下文相关内容可在《概念》章节查看。本页面将介绍其管理方法。

代码库记忆文件

打开设置 → 知识 → 上下文并查看下方的代码库来源。Coroid会从已连接的代码库中读取这些文件:

  • AGENTS.md位于代码库根目录:通用智能体指令
  • CLAUDE.md位于代码库根目录:Claude指令
  • GEMINI.md位于代码库根目录:Gemini指令
  • .cursor/rules:Cursor的项目规则,可位于.mdc规则文件(包含子文件夹)或单个旧版文件中

这些文件通常被称为记忆文件。其启用的内容会在工作开始前被纳入智能体的项目上下文中。这些文件的名称并不限定于特定模型:启用的来源会被整合供Coroid的智能体使用。

现有文件会显示编辑操作按钮、预估词元数,以及一个控制智能体是否读取这些文件的开关。除非你手动禁用,否则来源默认处于启用状态。如果多个文件内容重复或相互矛盾,只需保留你希望智能体遵循的来源,禁用其余文件即可。

在已连接GitHub或GitLab代码库的项目中保存编辑内容时,系统会基于项目的pull request基准分支新建一个包含该变更的pull request分支。Coroid不会直接提交到你的默认分支,智能体只有在pull request合并后才会读取新版本。若项目代码库由Coroid托管,则会直接生成提交记录。保存前编辑器会提示相关信息。

Coroid读取Cursor规则的方式与Cursor自身的解析方式一致:

规则智能体获取的内容
alwaysApply: true完整规则
globs集合完整规则及其适用文件
仅description规则的路径和描述,以便智能体在相关场景下调取读取
以上皆无无内容:只有有人主动提及时,Cursor才会应用该规则。

普通.md文件位于.cursor/rules中时会被忽略,因为Cursor本身也会忽略它。该目录下的规则需在代码库中编辑,因此对应行没有编辑操作按钮。

创建表示该文件在Coroid的代码库检出结果中被确认不存在。如果读取失败,页面会提供重试按钮;访问失败并不意味着文件确实缺失。请先确认该文件是否已提交到已连接代码库的对应分支。执行任务时,智能体会读取任务的检出内容,因此该分支中指令文件的变更会对任务生效。

启用的记忆文件可以通过@path导入代码库中的Markdown内容,例如@AGENTS.md位于CLAUDE.md或@docs/conventions.md。路径是相对于包含引用的文件解析的。Coroid会处理嵌套导入、避免循环引用,且每个文件和相同的指令内容只会导入一次。代码示例和电子邮件地址中的引用不会被处理。代码库外的引用不会被加载,导入操作也无法绕过已明确禁用的代码库来源。

只有列出的来源会被自动检测。嵌套的AGENTS.md可以通过@导入;其目录范围不会被自动推断。

应用上下文

在应用上下文下,你可以将指令和引用存储在Coroid中。手动笔记和生成的项目上下文可以独立于代码库文件启用或禁用。这类条目适用于Git之外的内容。

添加上下文

选择添加上下文即可添加条目。每个条目包含标题和正文,后续可编辑或删除。

优质的条目应简短、具体且具有持久性。架构决策、风格规范、API合约、权责边界以及明确的禁止性规定都属于此类。入职指引以及代码库中显而易见的内容则无需纳入。

条目应分开命名

每个条目对应一个主题,标题需清晰说明涵盖内容。“错误处理规范”和“冻结模块”可被单独检索;而名为“备注”且同时包含两者的单个条目则无法被精准定位。

这一点很重要,因为上下文会根据当前工作内容选择性加载——详见渐进式技能。区分清晰的条目能让正确的内容匹配对应的任务。

参考资料

除了书面内容外,你还可以附加引用——即指向其他位置存储资料的链接和文档。当权威副本存放在Wiki或设计工具中,且你不想让副本出现版本滞后时,便可利用此项功能。

单任务上下文

项目级别的上下文适用于项目内的所有内容。对于仅与某项工作相关的资料——如工单、客户报告、设计文档——应将其附加到对应任务中。若把特定任务的备注放入项目上下文中,就会干扰后续所有任务的处理。

确保信息准确

过时的上下文比缺失的上下文危害更大,因为智能体将其视为权威依据。一旦规范发生变化,需在修改代码的同一变更中同步更新相关条目。

查看现有内容

偶尔以新人的视角阅读上下文内容。条目会不断累积,而一年前迁移过程中撰写的条目如今可能会产生误导。