内容
XRef人工智能代理经常在工作一半时停止,猜测缺失的上下文,或产生看似合理但无法审查或移交的成果RefKit 是一个可移植的和存储库模型,用于人工智能,必须重现领域程序和它作为自己的控制存储库运行,并帮助人工智能代理:
- 在行动前加载正确的知识
可重用的技能
-和证据
- 在代理和会话之间保留移- 只有通过明确的质量关闭工作
该包提供 XID 解析、紧凑的运行时合约、技能执行、基于目录的上下文加载、确定性的关闭门工具和在相同规则下的薄 MCP 适配器。
▶️ 下载 2 分钟概述:[为什么 XRefKit 存在以及它如何帮助 AI 团队使用领域知识](https://raw.githubusercontent.com/synthaicode/XRefKit/main/readme.mp4)
## 安全性和 API 密钥
XRefKit 不需要 Claude、OpenAI、GitHub 或其他提供商的 API 密钥来探索存储库。
该存储库是用于人工智能辅助工作的治理和知识运营框架。它不要求用户将 API 密钥粘贴到存储库、问题跟踪器、提示或配置文件中。
如果您将 XRefKit 与 Claude Code、Codex 或 GitHub Copilot 等外部 AI 代理一起使用,请通过此存储库外部的官方提供商机制对其进行身份验证。
不要将机密、API 密钥、访问令牌、`.env` 文件或提供商凭证提交到此存储库。
XRefKit 不包括存储库管理的 Claude 设置、钩子、MCP 服务器自动批准或提供商端点重定向。
在存储库中运行任何 AI 代理之前,请查看代理启动文件设置。XRefKit库控制的代理配置视为的一部分。
## 问题
使用工作会产生反复问题:

- AI 可以根据不完整的上下文或不支持的猜测采取行动
- 程序、领域事实和判断标准在混杂在一起
- 执行、检查和移交合并为一个不透明的步骤
- 工作在代理、人类或会话之间难以继续
- 输出可能缺乏证据环纪律或可审计性
## XRefKit 提供的内容RefKit 通过分离以下 工作显式:
- 技能:可执行的工单位,每个技能都由能力/调责任三元组标识其执行和检查合约
:源支持的领域事实和仅在需要时加载的
- 工作流协议技能运行的通用、确定(阶段、验证、关闭)
- 语义路由:根据用户意图和技能目录选择正确的技能
- 证据:日志、判断、关注点和质量检查
- XID:稳定的引用,生存文件移动和重构,以便 AI 可以加载有针对性的上下文,而无需将整个存储库视为一个提示
这种分离可以防止提示、领域事实、执行步骤、审查标准和移交记录合并为一个不透明的指令块。

## 工作原理
1材料保存在 `sources/` 中。
2. AI 可读的知识保存在 `knowledge/`3. 工作在 ` (可执行过程,具有能力/调优/责任标识)和 ` 中定义。
4. 代理被语义路由到正确的技能,并仅加载相关的上下文。
5. 证据和质量门使不完整或不支持的工作可见。
## 快速入门
安装包并初始化实例:
```powershell
python -m pip install -e .
xrefkit init
xrefkit --help
```
在 stdio 上启动集成的 MCP 服务器:
```powershell
xrefkit mcp serve --repo . --transport stdio
```
情况下会将结构化关联事件写入 `work/mcp/x.jsonl`。在kit skill run` 返回_id` 后,客户端调用 MCP `bind_skill_run` 并 `client_record_command` 操作针对本地 `run_log`。后续的 MCP 知识搜索和 XID 解析然后与客户端技能运行共享相同的 `run_id`。客户端单独使用 `xrefkit skillaction load|apply` 记录实际模型上下文加载和判断应用。
XRefKit 设计为由 AI 代理驱动。代理首先解析启动合约 XID,从紧凑的目录中选择技能或源目标,并仅扩展选定的主体。
此处,`sources/` 是人类放置原始材料、现有技能工件、规则和示例的落脚点,AI 将把它们变成存储库管理的资产。
如果您正在迁移现有的技能:
1. 将源技能或相关放在 `sources/` 中。
2. 请求 AI 代理技能迁移到 XRefKit模型中。
3.让迁移过程分离过程、源支持的知识和运行时结构. 检查迁移的技能是否可用于预期的工作。
如果您新的技能:
1. 将源材料、规则或任务示例放在 `sources/` 中。
2. 请求 AI 代理使用技能创作流程(`skill_flow_authoring`)创建新的技能。
3. 根据需要让创作过程分离过程、源支持的知识和运行时结构。
4. 检查新的技能是否可用于预期的工作。
在这两种情况下:
1. 给 AI 代理一个请求,包含目标、预期输出和约束。
2. 检查 `work/` 记录作为操作内存,然后根据发生的情况完善技能、知识、保护条件、路由规则和质量门。
## 如何探索此存储库
将您的 AI 代理指向此存储库并直接询问。
已包含用于 Claude、Codex 和 GitHub Copilot 的启动指令文件。
这些文件是纯文本操作指令。不包含 API 密钥、提供商凭证、钩子、MCP 服务器定义或网络重定向设置。
代理可以读取操作合约并在上下文中解释存储库结构。
## 存储库地图
- `xrefkit/`:可安装的运行时、解析器、技能控制、工具注册表和 MCP 适配器
- `docs/`:面向人类的文档和策略
- `knowledge/`:源支持的知识片段
- `sources/`:用于验证的原始材料
- `skills/`:技能定义和
- `tools/`:XID 支持的客户端命令实现和打包资产
- `work/`:用于执行日志、判断、移交、回顾和改进输入的操作内存
- `agent/`:代理入口和操作合约
- `human-docs/`:面向人类的日语和英语文档、材料、资产和视频包
- `site/`:生成的发布输出、源清单和兼容性路由
## 运行时和上下文模型
- 基础运行时义务在结构上编写,并编译为带有源哈希和令牌预算的包资源。
- 存储库、已安装包和 MCP 提供程序解析相同的 XID 身份;冲突和过时的基础包会显式失败。
已发布的安装基础运行时包是生成的。正式消费者必须首先读取 `xrefkit/resources/base/current.json`,然后从引用的 `generations/<generation>/` 目录加载两个文件。顶级 `contracts.json` 和 `model_body.md` 文件仅是兼容性快照;它们不是权威源,不得用于生成一致性检查。
- 源结构分为目标目录和查找目录。AI 加载列表后选择详细信息。
- `xrefkit catalog maintain --apply-safe` 仅提升明确的候选发现;冲突保留在审查队列中。
- MCP 公开共享的解析器和目录。它不拥有独立的领域规则或执行客户端工具。
## 入口点
- 人类文档:`docs/000_index.md`
- 面向人类的语言树:`human-docs/ja/000_index.md`,`human-docs/en/`
- 代理入口:`agent/000_agent_entry.md`