关于 Pathrule
Pathrule 是面向编码 Agent 的开源、本地优先知识层。它按代码路径保存项目记忆、规则和技能,并向支持的 Agent 与 MCP 客户端提供相关上下文。
主要功能
- 01按路径管理记忆、规则和技能
- 02按相关性及提示词预算排序上下文
- 03通过钩子和路径规则文件传递信息
- 04本地知识存储与控制台
- 05支持多种编码 Agent
适用场景
- 01在不同 Agent 会话间保留项目决策
- 02只向 Agent 提供与当前代码相关的笔记
- 03在已连接的 Agent 间共享项目知识
- 04浏览和编辑本地知识
MCP 相关
Pathrule 内含本地 MCP 服务,向 MCP 客户端提供 `get_context` 工具。Pathrule Cloud 也提供远程 MCP 端点。
配置
远程服务无需本地安装。选择你使用的客户端,复制配置或使用一键安装。
https://cloud.pathrule.io/mcpclaude mcp add --transport http io-pathrule-pathrule https://cloud.pathrule.io/mcp{"mcpServers":{"io-pathrule-pathrule":{"type":"http","url":"https://cloud.pathrule.io/mcp"}}}在 Cursor 中打开{"servers":{"io-pathrule-pathrule":{"type":"http","url":"https://cloud.pathrule.io/mcp"}}}在 VS Code 中打开{"mcpServers":{"io-pathrule-pathrule":{"type":"http","url":"https://cloud.pathrule.io/mcp"}}}{"mcpServers":{"io-pathrule-pathrule":{"serverUrl":"https://cloud.pathrule.io/mcp"}}}命令在终端中运行;JSON 粘贴到对应客户端的 MCP 配置后重启。需要授权的服务会在首次连接时提示登录。
工具
详细介绍
English · Español · Français · Deutsch · 日本語 · Italiano · Türkçe · Português (Brasil)
你的 AI 会遗忘,Pathrule 会记住。
面向编码 Agent 的开源知识层。Pathrule 会将项目积累的知识保存为记忆、规则和技能,并按代码路径进行限定;在 Claude Code、Codex、Cursor、GitHub Copilot 和 Windsurf 执行操作前,只向它们提供当前任务所需的内容。
PathruleBench,2,000 项:每条链的成本降低 55% · 输入 token 减少 2.7 倍 · 97% 的记忆探测通过 · 查看数据
网站 · 文档 · 快速入门 · 基准测试 · 随时间变得更智能 · 更新日志
相同的请求,相同的 Agent。右侧,Pathrule 的钩子在 Agent 写下一行代码前,将为 apps/web/dashboard 归档的三条笔记交给它。
兼容 Claude Code · Codex · Cursor · GitHub Copilot · Windsurf · 任何 MCP 客户端
快速开始
需要 Node.js 22.14.0 或更高版本,支持 macOS、Linux 或 Windows。
npm i -g @pathrule/cli
pathrule setup --local # no account: knowledge stays on this machine
pathrule doctor # see what each agent receives
重启你的 Agent。从下一个会话开始,它就能获取即将操作的路径相关说明,并在工作过程中写下新的说明。
| 其他接入方式 | 命令 | 适用场景 |
|---|---|---|
| VS Code 扩展 | code --install-extension Pathrule.pathrule-vscode | 在代码旁管理知识库。可从 Marketplace 和 Open VSX 获取。 |
| Claude Code / Codex 插件 | /plugin marketplace add pathrule/pathrule · codex plugin marketplace add pathrule/pathrule | 在 Agent 内部安装。设置流程会先显示计划,再进行任何更改。 |
| Cursor 插件 | Cursor Marketplace → Pathrule | 在 Cursor 中使用相同的钩子、MCP 和技能。 |
| Gemini CLI / OpenCode 插件 | gemini extensions install https://github.com/pathrule/gemini-cli-extension · opencode plugin @pathrule/opencode --global | 在 Gemini CLI 和 OpenCode 中使用相同的设置。 |
| 任意 MCP 客户端 | npx -y @pathrule/mcp | 适用于没有插件系统的 Agent。已列入官方 MCP Registry。 |
| 本地控制台 | pathrule ui | 在 127.0.0.1 上浏览和编辑知识库。无需账号。 |
| 远程 MCP | claude mcp add --transport http pathrule https://cloud.pathrule.io/mcp | 无需安装即可试用。没有钩子,也不支持本地模式。 |
| 从源代码安装 | pnpm install && pnpm cli:bundle | 参与 Pathrule 开发。参见 docs/quickstart.md。 |
只需说明一次
编码 Agent 每次会话开始时都是空白状态。因此,同一个纠正会日复一日、在不同 Agent 之间反复出现:
| 日期 | Agent | 你输入的内容 | |
|---|---|---|---|
| 周一 | Claude Code | “用我们的 API 客户端,不要用 fetch” | 第 1 次 |
| 周二 | Claude Code | “再说一次:用 API 客户端,不要用 fetch” | 第 2 次 |
| 周三 | Codex | “我们用 API 客户端。” | 第 3 次 |
| 周四 | Cursor | “我昨天说过了。用 API 客户端。” | 第 4 次 |
| 周五 | Claude Code | “用 API 客户端。不要用 FETCH。” | 第 5 次 |
五个会话、三个 Agent,却什么也没记住。使用 Pathrule,只需说一次:
- 像平常一样修正一次。
- Pathrule 会将其归档到相关代码旁边:作为
features/上的记忆,而不是写进每个会话都必须读取的文件。 - 从下一个会话开始,每个 Agent 都能知晓,无论你打开的是哪个 Agent。
只获取重要内容
一个工作区会积累数百条说明。编辑 features/orders 的 Agent 只需要其中四条。
系统会根据路径、范围和相关性匹配知识,然后将其控制在每条提示词的预算内。强制规则不会因空间不足而被删减。未能纳入的内容会按标题列出,Agent 可以据此请求获取。当提示词提到某个函数或类型时,钩子还会指出其定义所在的文件和行号(JS/TS、Python、Go)。
三种知识类型
| 类型 | 内容 | features/ 下的示例 |
|---|---|---|
| 记忆 | 以简短 Markdown 形式记录决策、注意事项和事件。 | “使用 API 客户端。它会处理身份验证和重试。” |
| 规则 | Agent 必须遵循的约束,优先级高于建议。 | “通过 React Query 加载数据。” |
| 技能 | Agent 可运行的可复用流程和检查清单。 | “完成前先运行检查。” |
三种接入方式
| 渠道 | 何时传递给 Agent | 成本 |
|---|---|---|
| 按路径限定的规则文件 | Claude Code 在会话开始时读取 Pathrule 自己的 .claude/rules/pathrule/,每个文件都限定适用路径。你的 CLAUDE.md 和 AGENTS.md 保持原样。 | 由客户端缓存。 |
| Hooks | Agent 执行操作前:会话开始时、每次收到提示词时以及使用文件工具时。仅重新发送新增或变更的上下文。 | 计入每条提示词的预算。 |
MCP get_context | Agent 按需请求,深度取决于请求需要。 | 每个 MCP 客户端都可以使用。 |
为什么不直接用 CLAUDE.md?
每一步都会完整读取 CLAUDE.md 文件,因此团队每增加一条说明,每次会话的成本都会增加。Pathrule 则只为每条提示词发送路径和任务所需的内容。 PathruleBench 使用相同的 Agent、相同的提示词和相同的隐藏检查,对比了 500 到 2,000 条团队知识时的差异。
| 团队知识为 2,000 条时 | CLAUDE.md | Pathrule |
|---|---|---|
| 8 个会话组成的链的成本 | $3.89–$4.21 | $1.76–$1.89 |
| 一条链的输入词元数 | 11.8–12.5 M | 4.3–4.7 M |
| 通过的记忆探测 | 89% | 97% |
| 通过所有记忆探测的链 | 9 条中有 0 条 | 9 条中有 5 条 |
| 只说过一次的习惯,之后仍能遵循 | 78% | 97% |
| 保留从失败命令中学到的内容 | 33% | 78% |
| 每条提示词要求完成的工作 | 100% | 100% |
从 500 条增加到 2,000 条时,使用 CLAUDE.md 的链成本会增加 89–98%。使用 Pathrule 时,成本变化在 −1% 到 +10% 之间。你的知识库可以增长,账单却不会随之增加。
在 Python、Go 和 TypeScript 中使用 Claude Code 与 claude-sonnet-5-5;知识为 2,000 条时,每组测试运行九条链(每种语言三条);每项通过与否均由可执行测试判定,不使用模型评判。Pathrule 组使用此仓库的开源 CLI 本地模式:无 Cloud,无模型。
查看全部条件、链和检查方式,以及如何自行运行 → pathrule/benchmark
用得越久,就越智能。
第一天无需账号、网络或模型。之后的一切,都建立在你和 Agent 已经在此代码库中完成的工作之上。
| 时间 | Pathrule 的作用 | 运行位置 |
|---|---|---|
| 第 0 天 基础 | 将钩子和本地 MCP 服务接入你的 Agent。你写下的内容会按路径、在预算范围内,通过钩子和 Claude Code 的路径范围规则传递;你自己的 CLAUDE.md 和 AGENTS.md 保持原样。 | 开源,在本机运行 |
| 第 1 周 记忆 | 你在提示词中表达的决定(“从现在起……”“我们决定……”)会以你自己的措辞保存下来。失败命令带来的经验教训只保存一次。每条笔记都会归档在相关代码旁边,之后只会再次发送新增或变更的上下文。 | 开源,在本机运行 |
| 第 1 个月 你的习惯 | 你表达的偏好会保存在自己的本地文件中。随口说过一次的偏好会暂且留存;在另一个会话中再次提到后,它就会传递给每个 Agent。你指定为长期偏好的内容会立即生效。项目规则始终优先于个人规则。 | 开源,在本机运行 |
| 第 3 个月 规模化 | 即使有数千条笔记,会话大小也保持不变:根规则文件维持在约 6k 个字符,其余内容按提示词发送。说明代码位置的句子会标记为 (as of writing),因此队友移动文件后,Agent 会跟随代码。当编辑写入一个已被更新决定取代的值时,钩子会在该次编辑中引用这条决定。 | 开源,在本机运行 |
| 由你选择 团队 | 每台机器、每位成员都能使用相同的知识。对于 Cloud 工作区,模型还会读取 Pathrule 的短语规则未能识别的提示词,并以你的措辞保留你希望长期生效的句子。费用从 AI Credits 中扣除。 | Pathrule Cloud,可选加入 |
你的机器上不会运行任何模型。团队方案之前的所有功能都属于开源 CLI,也是上方基准测试所测量的同一路径。
切换 Agent,保留知识。
| Agent | 执行前 | 指令文件 | MCP |
|---|---|---|---|
| Claude Code | 钩子,包含提示词钩子 | Pathrule 自己的 .claude/rules/pathrule/ | 本地或远程 |
| Codex | 钩子,包含提示词钩子 | — | 本地或远程 |
| Cursor | — | — | 本地 |
| GitHub Copilot | — | — | 本地 |
| Windsurf | — | — | 本地 |
| 任意 MCP 客户端 | — | — | 本地或远程 |
不只是另一份规则文件
| 规则文件 | Pathrule | |
|---|---|---|
| 编写方式 | 手动编写,手动更新 | 随着你和 Agent 的工作不断扩展 |
| 覆盖范围 | 每个文件对应一个工具 | 所有已连接的 Agent |
| 传递方式 | 每个会话都发送全部内容 | 仅发送路径和任务所需的内容 |
| 变更方式 | 有人编辑时更新 | 进行版本管理;新知识会取代旧知识 |
保留你的 CLAUDE.md 和 AGENTS.md:Pathrule 不会编辑它们。它会按路径和任务传递其余内容,覆盖单个文件无法涵盖的部分。
此仓库包含什么
这是 Pathrule 的开源基础。它无需账户或网络服务即可运行:包括存储、检索与排序、MCP 服务、钩子、学习循环和命令行。
| 部分 | 是否包含 | 许可证 |
|---|---|---|
| 基础组件:协议、Agent 中间表示、本地知识库、宿主、MCP 服务、命令行、Pathrule Cloud 客户端、Agent 集成、Local Console、VS Code 扩展 | 是 | Apache-2.0 |
| Pathrule Cloud:团队工作区、同步、Web 控制台、远程 MCP、Cloud 模型层 | 否 | 专有 |
11 个软件包
protocol · agent-ir · core · integrations · mcp · host · ui · local-console · cloud · cli · vscode
pnpm install
pnpm typecheck # every package
pnpm test # every package's tests
pnpm build # each package's npm build
你的代码仍归你所有
- 源代码绝不会自动上传。
- 本地模式无需账户、不运行模型,开源命令行也不会发送遥测数据。
- 你的 Agent 保留自己的模型提供商。Pathrule 不是模型、Agent 或 IDE。
- Pathrule Cloud 为可选服务。登录后,它会存储你的知识,并使用提示词为其排序;其模型层可能会读取提示词,以寻找值得长期保留的决策。
社区
贡献者
贡献指南(DCO 签署) · 行为准则 · 报告漏洞 · 获取帮助 · 商标政策
许可证
Apache-2.0。请参阅 LICENSE 和 NOTICE。Pathrule 名称和徽标不受 Apache-2.0 许可。
评论
一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。