JinDaGe - pretorin-cli MCP Details

article

README

🚀 Pretorin - 开发者合规工具

Pretorin 是一款为开发者打造的合规工具，可与 AI 代理或 CI 管道集成，助力开发者便捷处理合规数据、实现上下文及证据工作流。

🚀 快速开始

安装与登录

uv tool install pretorin
pretorin login

运行演示

bash scripts/demo-walkthrough.sh

✨ 主要特性

两种使用模式

Pretorin 托管模型模式：运行 pretorin agent run 并通过 Pretorin /v1 端点路由模型调用。
自带代理模式：运行 pretorin mcp-serve 并将 MCP 服务器连接到现有的 AI 工具（如 Claude Code、Codex CLI、Cursor 等）。

📦 安装指南

托管模型工作流（推荐）

使用 Pretorin API 密钥进行身份验证：

pretorin login

可选：将模型流量指向自定义/自托管的 Pretorin 端点：

pretorin config set model_api_base_url https://platform.pretorin.com/v1

验证运行时设置：

pretorin agent doctor
pretorin agent install

运行代理任务：

pretorin agent run "Assess AC-2 implementation gaps for my system"

关键行为：

首选设置是使用 pretorin login 且不进行 shell 级别的 OPENAI_API_KEY 覆盖。
模型密钥优先级为：OPENAI_API_KEY -> config.api_key -> config.openai_api_key。
如果在 shell 中设置了 OPENAI_API_KEY，它将覆盖存储的登录凭据。

添加到您的 AI 工具

1. Claude Code

claude mcp add --transport stdio pretorin -- pretorin mcp-serve

通过 .mcp.json 进行团队设置：

{
  "mcpServers": {
    "pretorin": {
      "type": "stdio",
      "command": "pretorin",
      "args": ["mcp-serve"]
    }
  }
}

2. Codex CLI

添加到 ~/.codex/config.toml：

[mcp_servers.pretorin]
command = "pretorin"
args = ["mcp-serve"]

关于 Claude Desktop、Cursor 和 Windsurf 的设置，请参阅 docs/MCP.md。

💻 使用示例

基础用法

# 安装并登录
uv tool install pretorin
pretorin login

高级用法

# 运行代理任务
pretorin agent run "Assess AC-2 implementation gaps for my system"

📚 详细文档

核心命令

平台支持的审查和更新工作流是单范围的：首先使用 pretorin context set 设置一个活动的 system + framework，然后在该范围内运行证据、笔记、监控、叙述或 MCP 辅助合规命令。多框架工作必须拆分为单独的运行。证据、叙述和笔记都支持本地优先工作流：在本地创建、列出，然后推送到平台。

| 命令 | 用途 | |---------|---------| | pretorin frameworks list | 列出可用框架 | | pretorin frameworks control <framework> <control> | 获取控制详情和指南 | | pretorin context set | 设置活动系统/框架上下文 | | pretorin evidence create | 创建本地证据文件 | | pretorin evidence list | 列出本地证据文件 | | pretorin evidence push | 将本地证据推送到 Pretorin | | pretorin evidence search | 搜索平台证据 | | pretorin evidence upsert <ctrl> <fw> | 查找或创建证据并链接它 | | pretorin narrative create | 创建本地叙述文件 | | pretorin narrative list | 列出本地叙述文件 | | pretorin narrative push | 将本地叙述推送到 Pretorin | | pretorin narrative get <ctrl> <fw> | 获取当前控制叙述 | | pretorin narrative push-file <ctrl> <fw> <sys> <file> | 推送单个叙述文件 | | pretorin notes create | 创建本地笔记文件 | | pretorin notes list --local | 列出本地笔记文件 | | pretorin notes push | 将本地笔记推送到 Pretorin | | pretorin notes list <ctrl> <fw> | 列出平台控制笔记 | | pretorin notes add <ctrl> <fw> --content ... | 直接添加控制笔记 | | pretorin monitoring push | 推送监控事件 | | pretorin agent run "<task>" | 运行由 Codex 驱动的合规任务 | | pretorin review run --control-id <id> --path <dir> | 审查本地代码的控制覆盖情况 | | pretorin mcp-serve | 启动 MCP 服务器 |

工件创作规则

叙述和证据的 Markdown 必须对审计人员具有可读性：不使用 Markdown 标题，使用列表、表格、代码块和链接。
在平台端支持文件上传之前，暂时禁用 Markdown 图像嵌入。

配置

凭据存储在 ~/.pretorin/config.json 中。

| 变量 | 描述 | |----------|-------------| | PRETORIN_API_KEY | 用于平台访问的 API 密钥（覆盖存储的配置） | | PRETORIN_PLATFORM_API_BASE_URL | 平台 REST API 基础 URL (/api/v1/public) | | PRETORIN_API_BASE_URL | PRETORIN_PLATFORM_API_BASE_URL 的向后兼容别名 | | PRETORIN_MODEL_API_BASE_URL | 代理/测试框架流程使用的模型 API 基础 URL（默认：https://platform.pretorin.com/v1） | | OPENAI_API_KEY | 可选的代理运行时模型密钥覆盖 |

文档查看

完整文档使用 mdbook 构建。要在本地查看：

# 安装 mdbook（如果没有安装）
cargo install mdbook

# 启动文档服务并在浏览器中打开
cd docs && mdbook serve --open

这将在 http://localhost:3000 启动一个本地服务器，并支持实时重新加载。

要构建静态 HTML 而不启动服务：

cd docs && mdbook build
# 输出在 docs/book/ 中

快速链接

🔧 技术细节

开发步骤

git clone https://github.com/pretorin-ai/pretorin-cli.git
cd pretorin-cli
uv pip install -e ".[dev]"
pytest
ruff check src/pretorin
ruff format --check src/pretorin

📄 许可证

本项目采用 MIT 许可证。详情请参阅 LICENSE。

⚠️ 重要提示

Pretorin 目前处于封闭测试阶段。框架/控制浏览对所有人开放。平台写入功能（证据、叙述、监控）需要测试代码。点击此处注册以获取早期访问权限。

pretorin-cli