recordant

Recordant

Recordant 是一款专利申请中的诊断与决策台账引擎，适用于任何宿主软件系统。将目标系统的代码仓库、变更日志和日志文件交给它，它便会定期扫描并生成一份运维简报：哪些内容发生了变化、哪些内容似乎存在问题、哪些问题已修复，以及按优先级排列的诊断列表——此外，还提供一个基于聊天的 MCP 控制台，可访问相同数据。

使用你自己的 LLM（Anthropic、OpenAI 或 Gemini——你的密钥、你的用量、你的账单）。Recordant 不预设任何提供商。

15 分钟安装并生成首份简报

1. 安装软件包和你所用 LLM 提供商的 SDK（只需安装你使用的那个）：

   pip install "recordant[anthropic]"     # or [openai], [gemini], or [all]
   

2. 将 recordant.example.toml 复制为 recordant.toml 并设置：

   • repo_root — 要诊断的目标代码仓库
   • changelog_path — 通常为 CHANGELOG.md（如果不存在，则回退到 git log）
   • log_globs — 要进行健康扫描的日志文件
   • [llm] — 你的提供商、模型和 api_key_env（存放密钥的环境变量的名称，绝不是密钥本身）

3. 导出密钥并运行一个周期：

   export RECORDANT_LLM_KEY=sk-...
   recordant --config recordant.toml
   

   简报路径会输出到标准输出。简报、快照和（可选的）决策台账会写入你配置的 output_dir。

4. 按照配置中的 schedule_seconds 间隔安排运行（使用 cron / systemd timer / 你自己的调度器）。

整个流程就是这样。请参阅 ENGINE.md，了解适配器架构、配置参考和已知限制。

MCP 控制台

Recordant 还可作为 MCP 服务运行，通过标准输入/输出提供 7 个工具，供基于聊天的 MCP 客户端使用：

工具	用途
recordant_brief	自上一周期以来的最新变化简报
recordant_status	当前状态快照（健康状况、运行间隔、活动台账）
recordant_digest	未结事项、已接受风险登记册、已发布修复和截止日期
recordant_open_items	所有未结诊断及其时长、复发情况和证据
recordant_acknowledge	确认一项诊断（P0 项目无法确认）
recordant_accept_risk	将一项诊断列入已接受风险登记册
recordant_resolve	声明一项诊断已解决（根据变更日志进行审计）

默认启用令牌身份验证——不提供匿名模式。 服务需要有效的 RECORDANT_LICENSE_KEY，并会在启动时向许可证服务验证该密钥，然后才注册任何工具；即使只是短暂运行，也不会在未获授权的情况下运行。针对许可证服务的临时网络故障设有短暂的离线宽限期，但明确无效或已过期的密钥会立即被拒绝。

export RECORDANT_LICENSE_KEY=rk-...
recordant-mcp --config recordant.toml

将其添加到 MCP 客户端的配置中（Claude Desktop、Claude Code 等）：

{
  "mcpServers": {
    "recordant": {
      "command": "recordant-mcp",
      "args": ["--config", "/absolute/path/to/recordant.toml"],
      "env": { "RECORDANT_LICENSE_KEY": "rk-..." }
    }
  }
}

许可和定价

Recordant 是许可软件，并非开源软件（参见 LICENSE）。获取密钥并查看当前定价，请访问 **https://mentorsentinel.ai/markets-ai-governance.html**。

Docker

Recordant 以编译后的镜像形式提供——没有可供构建的引擎源代码，因此 docker build 不属于客户工作流。拉取已获许可的镜像（按照 BUILD-RELEASE.md 发布）并运行：

docker pull recordant/recordant:<version>
docker run -v $PWD/recordant.toml:/app/recordant.toml:ro \
           -v $PWD/target-repo:/app/target-repo:ro \
           -e RECORDANT_LLM_KEY \
           recordant/recordant:<version> --config recordant.toml

该镜像带有签名（cosign），并附带 SBOM（syft），因此你无需获取可读的引擎源代码，也可以审查其行为——包括依赖项和出站流量；验证命令请参阅 BUILD-RELEASE.md。

请参阅 docker-compose.example.yml，了解基于 compose 的设置，其中包含 MCP 控制台服务。

支持

发现错误或有功能请求？请提交 issue——参见 .github/ISSUE_TEMPLATE/。如有许可或账户相关问题，请使用上方的定价页面。

专利

Recordant 的推理循环和决策台账生命周期正在申请专利中（可按要求提供美国申请编号）。“专利申请中”表示已提交、尚未审查的临时申请——目前尚未授权任何专利。