概述

​

Kody Rules 界面中的两种类型

​

审查规则

​

创建自定义规则

​

变量、文件引用和 MCP 函数

• 文件级：
  • fileDiff - 对正在分析的单个文件所做的特定更改
• PR 级：
  • pr_title - 拉取请求的标题
  • pr_description - 拉取请求的描述/正文
  • pr_total_additions - 添加的总行数
  • pr_total_deletions - 删除的总行数
  • pr_total_files - 更改的文件总数
  • pr_total_lines_changed - 修改的总行数
  • pr_files_diff - 整个拉取请求中所有更改的完整差异
  • pr_tags - 与拉取请求关联的标签
  • pr_author - 拉取请求的作者
  • pr_number - 拉取请求编号

• @file:path/to/file.ts - 引用您正在编辑规则的同一代码库中的文件
  • 在引用当前代码库中的模板、示例或配置文件时使用
  • 示例：@file:src/services/userService.ts
• @repo:org/project - 引用另一个代码库中的文件或在代码库上下文外配置规则时
  • 在跨多个代码库强制一致性或引用共享标准时使用
  • 示例：@repo:team/api-standards

• 当您保存规则时，Kody 会自动识别文件引用
• 引用在后台解析——观察编辑器旁边的状态指示器以确认完成
• 使用准确的 blob 样式路径（例如 src/utils/helpers.ts）而不是占位符
• 文件内容注入规则上下文，允许 Kody 比较、验证或强制模式
• 在文件级和拉取请求级规则中都有效

• 代码库操作：列出代码库、获取代码库文件、内容和语言
• PR 分析：获取拉取请求详细信息、列出提交、分析 PR 文件内容
• 文件内容检索：获取文件内容和差异
• 跨文件验证：跨多个文件执行高级分析
• 自定义集成：您作为插件连接的任何 MCP 服务器（Jira、自定义工具等）

• 使用特定的文件路径而不是通用占位符
• 引用代表团队标准的稳定文件
• 在保存规则之前测试文件引用是否存在以避免解析错误
• 结合变量、文件引用和 MCP 函数进行全面验证

​

文件级规则

• 使用 @file 或 @repo 与参考文件进行比较
• 使用 MCP 函数获取相关文件或代码库数据
• 结合变量、文件引用和 MCP 函数来验证模式、检查一致性或强制架构规则

• Rule name：清楚地定义规则目的
• Execution mode：Per file（默认）
• Path：使用 glob 模式将规则限制为特定文件或目录（留空则应用于所有文件）
• Instructions：使用 fileDiff，使用 @file/@repo 引用文件，并调用 MCP 函数以编写具有丰富上下文的强大规则。新规则可以使用 Start with a popular template
• Severity：设置为 Critical、High（默认）、Medium 或 Low
• Advanced settings：Inheritable（默认开启；参见规则继承）和 Code examples（Bad example / Good example）

// 如果增量不完全为 1，则存在无限循环的风险
for (let i = 0; i != 10; i += 2) {
  console.log(i); // 将打印 0, 2, 4, 6, 8, 10, 12, 14... 永远
}

// 如果在迭代期间修改数组，则存在风险
let items = [1, 2, 3, 4, 5];
for (let i = 0; i != items.length; i++) {
  if (items[i] === 3) {
    items.push(6); // 修改长度，可能导致无限循环
  }
}

// 安全：循环将始终终止
for (let i = 0; i < 10; i += 2) {
  console.log(i); // 将打印 0, 2, 4, 6, 8 并停止
}

// 即使修改数组也是安全的
let items = [1, 2, 3, 4, 5];
for (let i = 0; i < items.length; i++) {
  if (items[i] === 3) {
    items.push(6); // 循环仍将安全终止
  }
}

​

拉取请求级规则

• 使用 pr_title、pr_description、pr_author 等变量验证 PR 元数据
• 使用 @file 或 @repo 引用配置文件或模板
• 使用 MCP 函数获取其他上下文（例如，检查相关文件是否存在，根据代码库结构验证）
• 结合 PR 变量、文件引用和 MCP 函数来创建全面的验证规则

• 每个服务文件必须有相应的测试文件
• PR 描述必须完整，清楚地说明添加或删除了什么
• 在控制器中创建新路由时，必须在 routes.json 中注册
• 使用 pr_total_lines_changed 标记超过大小限制的 PR
• 结合 pr_files_diff 和 MCP 函数来验证跨文件依赖关系
• 引用 @file:routes.json 以确保注册新路由
• 使用 MCP 函数检查修改的服务文件是否存在测试文件

​

编写强大的规则

• 使用 fileDiff 分析文件中的特定更改
• 使用 @file:path/to/template.ts 引用相关文件以与模式进行比较
• 调用 MCP 函数以获取代码库数据或检查相关文件是否存在
• 示例：“分析 fileDiff 并确保它遵循 @file:src/utils/example.ts 中的模式。使用 MCP 验证相关测试文件是否存在。”

• 使用 PR 变量（pr_title、pr_description、pr_files_diff 等）验证 PR 元数据和大小
• 使用 @file:config.json 或 @repo:org/shared-config 引用配置文件以强制一致性
• 调用 MCP 函数执行跨文件验证、检查代码库结构或获取提交历史
• 示例：“如果 pr_files_diff 包含新路由，验证它们是否在 @file:routes.json 中注册。使用 MCP 检查所有修改的服务文件是否存在相应的测试文件。”

• 使用 @repo:org/project 引用其他代码库中的文件以保持项目之间的一致性
• 与 MCP 函数结合以根据共享标准或模板进行验证
• 示例：“确保 API 端点遵循 @repo:org/api-standards 中定义的模式。使用 MCP 获取最新的标准文档。”

• MCP 函数在规则评估期间执行，使规则能够适应当前代码库状态
• 获取有关文件、提交或代码库结构的实时数据
• 示例：“使用 MCP 检查当前代码库结构并确保新文件遵循现有目录模式。”

​

从规则库导入

• 在 Code review → Kody Rules（Review Rules 选项卡）中，点击 Discovery 打开规则库（Rules Marketplace）。当规则列表为空时，也可以通过 Browse the library 进入，或在 ⌘K 命令面板中搜索 Rules library。
• 从 Featured 开始，或切换到 Browse 搜索完整目录，并按 Severity、Language 或 Packs 过滤规则。
• 打开一条规则并点击 Add to my rules，使用旁边的代码库选择器选择 Global 或应获得该规则的代码库（及目录）。

• 安全性：“禁止使用不安全的 MD5 哈希。”
• 可维护性：“将 React 组件限制为少于 150 行。“

​

记忆

​

记忆的工作原理

• 全面注入：记忆被包含在代码审查分析（跨文件、安全保障、PR 级规则）和对话交互中
• 高优先级上下文：AI 将记忆视为高优先级指导，确保团队约定得到一致应用
• 未来建议更好：记忆帮助 Kody 停止反复对仓库做出同样的错误假设
• 智能去重：创建新记忆时，Kody 使用基于 LLM 的解析机制来决定是创建、跳过（如果重复）还是更新现有记忆

​

创建记忆

​

通过对话

@kody remember: this repo mirrors a third-party API, so some payload fields intentionally stay snake_case.

@kody please remember: this service follows hexagonal architecture and keeps adapters at the edge.

@kody this repo mirrors a third-party API, so some payload fields intentionally stay snake_case.

@kody in this service, tests usually live next to the implementation files rather than in a central test folder.

@kody the billing module is mid-migration, so prefer incremental fixes over broad refactors.

​

通过 UI

1. 在侧边栏 Code review 分组顶部的范围选择器中选择 Global（或代码库 / 目录），然后打开 Kody Rules。记忆会在您此处选择的范围内创建
2. 切换到 Memories 选项卡
3. 点击 New memory（列表为空时为 Add a memory）
4. 填写 Memory name 和 Instructions，然后点击 Create memory

​

记忆范围

​

LLM 生成记忆的审批

1. 在您想要的范围（Global、某个代码库或某个目录）下前往 Code review → Kody Rules
2. 点击 Configuration 打开侧边面板
3. 启用 Kody knowledge approval

• AI 生成的规则和记忆进入待审状态，在批准之前不会生效
• Review Rules 和 Memories 选项卡上的徽章显示待审数量
• 待审项目会出现在页面顶部的 Pending review 区域中，您可以在那里批准或丢弃它们（参见下方的待审核）
• 新规则/记忆的创建和对现有规则/记忆的更新都通过审批流程

kodyKnowledgeApproval:
    enabled: true

​

待审核

• 新规则和记忆：等待批准的 AI 生成项目。选择 Approve 激活该项目，或选择 Discard 拒绝它。
• 更新：对现有规则或记忆的建议更改，以差异形式显示。选择 Update existing 应用更改，选择 Create new instead 保留原有项目并将该建议添加为单独的项目，或选择 Discard 拒绝它。

​

下一步