dotrepo

dotrepo

查询仓库的用途、构建和测试命令、文档及所有者。

dotrepo 是一种开放的仓库元数据协议，配有参考工具链和公共索引。它以 JSON 格式通过 MCP，或从本地 .repo 文件中，向 Agent 和工具提供这些信息。每条记录都包含来源和可信度背景，方便你判断是否采用查询结果，或检查上游信息。

试用：了解 ripgrep

无需安装任何内容或克隆仓库，即可获取索引中的档案：

curl -sS https://dotrepo.org/v0/repos/github.com/BurntSushi/ripgrep/profile.json

响应按用途、执行、文档和所有权进行分类。请检查 record.generatedAt、record.freshnessStatus、冲突信息，以及任务所需的字段。freshness.generatedAt 表示导出时间，而非源事实的时间。若答案缺失、过时或存在冲突，则需要检查上游信息。返回的命令是供审查的数据，并不代表你可以执行它们。

连接你的 Agent

使用 Rust 工具链安装稳定版 MCP 服务，或使用稳定版发布包：

cargo install dotrepo-mcp --version 1.0.3 --locked

对于使用 mcpServers 配置的客户端：

{
  "mcpServers": {
    "dotrepo": { "command": "dotrepo-mcp", "args": [] }
  }
}

请客户端使用以下参数调用 dotrepo.lookup：

{
  "repositoryUrl": "https://github.com/BurntSushi/ripgrep",
  "path": "repo.test"
}

CLI、LSP 和 VS Code 扩展的安装方式请参阅安装说明；有关回退规则和可运行客户端的信息，请参阅使用方集成。

**版本很重要：**稳定版为 v1.0.3；此分支是已发布的预发布版本 2.0.0-rc.1。稳定版包含有界命令提取修复、升级时禁止写入的保护措施，以及响应大小上限。较新的字段证据架构、执行上下文和额外 MCP 目标检查仍保留在 main 上。请参阅版本对比和稳定版文档。

用途

• **了解仓库：**在决定检查哪些源文件之前，获取用途、文档、所有者和报告的命令
• **Agent 集成：**先查询一次并保留可信度和时效信息；如果答案不符合任务需求，再回退到上游信息
• **维护者元数据：**确保原生 .repo 文件和受支持的文档块符合验证要求和生成内容检查
• **发现仓库：**通过公共 API搜索、比较事实档案并遍历仓库关系

索引覆盖层由公开源材料生成，因此维护者无需让其仓库采用 dotrepo，该仓库也能出现在索引中。原生 .repo 文件则让维护者能够掌控内容。常规生成记录会经过机器检查；verified 并不表示经过人工审查，也不保证每个字段都正确。

为仓库添加记录

从发布包安装稳定版 CLI，或使用 cargo install dotrepo-cli --version 1.0.3 --locked 安装，然后：

# Start from existing README.md, CODEOWNERS, and SECURITY.md:
dotrepo --root <repo> import
# Review the generated .repo, then:
dotrepo --root <repo> validate
dotrepo --root <repo> query repo.build --raw
dotrepo --root <repo> trust
dotrepo --root <repo> generate --check

若要从空白脚手架开始，请使用 init，而不是 import。稳定版维护者指南介绍了采用流程；同步边界说明 dotrepo 可以管理哪些文件和区域。

限制与证据

• 元数据有助于了解项目概况。架构研究、适用性判断、调试和代码更改仍需检查源代码
• 覆盖率、正确性、完整性和时效性彼此独立。即使记录标记为 verified，也可能不完整、过时或有误；只有在生成记录的版本和抓取过程保存了字段级证据时，才能查看这些证据。请参阅信任模型
• 测量页面报告字段是否存在以及建模请求数。这些数据并不代表准确性，也不代表经测量得出的端到端 Agent 节省效果
• 正面对比基准测试保留了相对于 GitHub API + README 基线的胜出与失利记录。修复其中的示例可作为回归证据，但不能证明结果具有普遍性
• 持续获得独立用户的采用仍是尚未达成的成功标准。仓库内客户端和 AI 访谈无法证明存在外部需求

接下来阅读

• 文档导航和版本兼容性
• 工具链与协议参考，包括 MCP 工具、验证范围和版本边界
• 托管 API 示例、公开架构，以及自有项目研究与后续试点
• 信任模型和权威规则
• 路线图、贡献指南和索引操作

如需开始实现，请先阅读路线图任务包和团队执行指南。仓库指南规定了契约；生成的报告和带日期的归档则记录结果证据。

仓库的 Python 工具链使用 uv：运行 uv venv、uv sync --dev --locked，然后通过 uv run 调用脚本和测试。