BriefLoop

BRIEFLOOP / 使用指南

外部 Agent 与 CLI

让已有 Agent 调用 BriefLoop，提交报告、保存修订并下载指定版本的 Word。

当前安装包：Mac 0.22.2、Windows 0.22.2。按钮与能力因渠道不同，以所装版本为准；不代表开发中功能已经随安装包发布。

前置条件

准备可备份的工作区；需要模型的操作须先完成宿主认证，并确认材料允许交给所选服务处理。

操作步骤

  1. 安装 briefloop CLI；在同一台机器打开目标工作区，配置模型、材料与企业背景选择。
  2. 执行 discover，只有 ready=true 才继续；执行 skill 获取与所装版本一致的协议说明。
  3. 先 inspect 确认来源 ID，再用稳定 request_id 提交 submit。以 query 查询返回的 job_id，保留失败和已保存草稿。
  4. 用 read 获取明确版本；改稿通过完整 editor_document 和 base_version 保存。export 排队后，查询 artifact_available，再 download。

成功后应该看到什么

返回真实任务和版本 ID；下载的 Word 由 CLI 核对哈希。原稿、修订和任务状态保持关联。

失败与边界

仅连接本机已有服务，不是远程 MCP Server。submit 使用 BriefLoop 配置的模型及额度；revise 保存外部 Agent 的修改。正式交付仍需原有审核。不要直接改 SQLite 或用新 request_id 重发结果未知的请求。

可复制的命令与请求

python -m pip install --upgrade briefloop
briefloop external --workspace "/absolute/workspace" discover
briefloop external --workspace "/absolute/workspace" skill
briefloop external --workspace "/absolute/workspace" request --file request.json

每次把一条 JSON 请求保存为 request.json，再执行上面的 request 命令。示例 ID 必须替换为实际响应中的 ID，不能直接提交占位符。

inspect

{
  "action": "inspect"
}

submit

{
  "action": "submit",
  "request_id": "report-unique-id",
  "source_ids": [
    "src_actual_id"
  ],
  "requirements": {
    "title": "本期简报",
    "objective": "概括已上传材料的变化及影响",
    "allow_web": false,
    "writing_mode": "general",
    "target_words": 500,
    "max_words": 700
  }
}

query

{
  "action": "query",
  "job_id": "job_actual_id"
}

read

{
  "action": "read",
  "version_id": "brief_actual_id"
}

export

{
  "action": "export",
  "request_id": "export-unique-id",
  "version_id": "brief_actual_id"
}
briefloop external --workspace "/absolute/workspace" download --job job_export_id --output "/existing/output/report.docx"

企业内报告使用 internal_report，并先完成企业背景维护选择；不能改写作模式绕过。改稿先读取完整文档，再用 revise、新的 request_id 和准确 base_version 保存。响应丢失时保留原 ID 与原内容重试。

Agent Skill 与完整协议 · GitHub

← 全部文档 · 选择安装方式 →