已废弃
Zed代理运营
Zed AgentOps帮助您运行编辑→ 验证→ 使用本地MCP服务器和为可恢复代理工作设计的项目模板在Zed内提交工作流。
目前支持macOS。
它做什么
- 为在Zed中使用AgentOps创建项目模板
- 为存储库、验证和面向简历的工作流助手提供本地MCP服务器
- 添加默认值
verify和verify-release您可以为项目扩展的入口点 - 保持足够的本地状态,以便代理在中断的会话中更可靠地恢复工作
- 将生成的项目模板、运行时工作流规则和助手行为与支持的v0.5.4合约对齐
此README是为该工具的用户编写的。它侧重于如何在实践中设置和使用AgentOps。
安装
使用Homebrew安装:
brew intall rioriost/tap/agentops_mcp_server这将安装:
agentops_mcp_serverzed-agentops-init
用法
Zed配置
在项目中开始使用AgentOps之前,请将Zed配置为使用MCP服务器。
对于v0.5.4,这是有效需要的。预期的工作流程假设:
- MCP服务器已在Zed中注册
- 代理面板可以调用它需要的AgentOps工具
- 工具权限中预先允许使用常用的AgentOps工具
将MCP服务器添加到Zed设置中:
{
"agentops-server": {
"command": "/opt/homebrew/bin/agentops_mcp_server",
"args": [],
"env": {
"PATH": "/opt/homebrew/bin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin"
}
}
}然后允许工作流程所依赖的MCP工具。一个实用的基线是:
{
"terminal": {
"default": "allow"
},
"mcp:agentops-server:workspace_initialize": {
"default": "allow"
},
"mcp:agentops-server:tx_event_append": {
"default": "allow"
},
"mcp:agentops-server:tx_state_save": {
"default": "allow"
},
"mcp:agentops-server:tx_state_rebuild": {
"default": "allow"
},
"mcp:agentops-server:session_capture_context": {
"default": "allow"
},
"mcp:agentops-server:repo_verify": {
"default": "allow"
},
"mcp:agentops-server:repo_commit": {
"default": "allow"
},
"mcp:agentops-server:repo_status_summary": {
"default": "allow"
},
"mcp:agentops-server:repo_commit_message_suggest": {
"default": "allow"
},
"mcp:agentops-server:tests_suggest": {
"default": "allow"
},
"mcp:agentops-server:tests_suggest_from_failures": {
"default": "allow"
},
"mcp:agentops-server:commit_if_verified": {
"default": "allow"
},
"mcp:agentops-server:ops_compact_context": {
"default": "allow"
},
"mcp:agentops-server:ops_handoff_export": {
"default": "allow"
},
"mcp:agentops-server:ops_resume_brief": {
"default": "allow"
},
"mcp:agentops-server:ops_start_task": {
"default": "allow"
},
"mcp:agentops-server:ops_update_task": {
"default": "allow"
},
"mcp:agentops-server:ops_end_task": {
"default": "allow"
},
"mcp:agentops-server:ops_add_file_intent": {
"default": "allow"
},
"mcp:agentops-server:ops_update_file_intent": {
"default": "allow"
},
"mcp:agentops-server:ops_complete_file_intent": {
"default": "allow"
},
"mcp:agentops-server:ops_capture_state": {
"default": "allow"
},
"mcp:agentops-server:ops_task_summary": {
"default": "allow"
},
"mcp:agentops-server:ops_observability_summary": {
"default": "allow"
}
}调整权限以匹配您自己的安全首选项,但如果这些工具被阻止,预期的工作流程将不完整。
机器可读工作流响应
在v0.5.4中,生命周期感知响应旨在具有足够的机器可读性,以便代理或客户端决定下一步做什么,而不依赖于散文。
对于与生命周期相关的成功响应,规范化的指导字段包括:
okcanonical_statuscanonical_phasenext_actionterminalrequires_followupfollowup_toolactive_tx_idactive_ticket_id
当信息可用时,响应还可以包括上下文字段,例如:
current_stepverify_statuscommit_statusintegrity_statuscan_start_new_ticketresume_required
这些字段描述了工具完成后产生的规范状态。换句话说,它们旨在告诉你是否应该开始、继续、验证、提交、明确结束任务,或者因为规范状态被阻止而停止。
与生命周期和状态相关的故障也旨在提供结构化的恢复指导。归一化失效形态包括:
ok: falseerror_codereasonrecoverablerecommended_next_toolrecommended_action
当已知时,故障响应还可以包括规范状态或完整性上下文,例如当前状态或阶段、活动事务标识、终端和与完整性相关的元数据。
解释主要领域的一种实用方法是:
canonical_status和canonical_phase描述由此产生的规范事务状态next_action描述了应采取的下一个生命周期步骤terminal告诉您交易是否已经是终端requires_followup告诉您是否还需要更多的生命周期工作followup_tool在需要时确定明确的后续工具
助手完成并不总是意味着事务完成。特别是,成功的提交助手可能会将事务留在非终端中 committed,这仍然需要显式的终端关闭,例如以结束任务 done 或 blocked.
使用初始化项目 zed-agentops-init
使用以下内容创建或更新AgentOps管理的项目:
zed-agentops-init my_project或者:
zed-agentops-init --update my_project使用 --update 当您已经有一个旧的AgentOps模板并希望将其刷新为当前的工作流契约时。
初始化会创建什么
跑步 zed-agentops-init 在Zed中设置开始使用AgentOps所需的文件:
.rules.zed/tasks.json.zed/scripts/verify.agent/tx_event_log.jsonl.agent/tx_state.json
它还:
- 如果Git存储库不存在,则创建一个Git存储库
- 将常见的忽略条目附加到
.gitignore - 尽可能保留现有文件
- 支持
--update刷新现有设置
基线 .agent/tx_state.json 故意为规范化的空事务状态。它包括正常运行时解释所需的主要顶级字段和元数据,包括:
schema_versionactive_txlast_applied_seqintegrity.state_hashintegrity.rebuilt_from_seqintegrity.drift_detectedintegrity.active_tx_sourceupdated_at
此基线旨在与更丰富的运行时重建状态形状兼容,而无需发明只有在规范事件回放后才能知道的运行时事实。
在Zed中打开项目
初始化后:
- 在Zed中打开项目目录
- 确保您的MCP服务器配置处于活动状态
- 打开代理面板
- 确认代理可以访问所需的AgentOps工具
- 从初始化的存储库根开始工作
对于支持的工作流,代理应在根依赖操作之前初始化工作区根,并应处理 .agent/tx_state.json 和 .agent/tx_event_log.jsonl 作为规范的本地工作流状态。
对生命周期感知响应的预期解释与规范状态有关。客户应该依靠结构化的响应字段来了解是否有要恢复的活动事务,新工单是否可以安全启动,以及助手的成功是否仍然留下明确的后续工作。
配置 verify / verify-release 根据需要
生成的模板包括:
.zed/scripts/verify.zed/scripts/verify-release
默认值 verify 剧本故意保守。扩展它以匹配您的项目。
一个常见的面向Python的设置是:
verify:对日常工作进行快速本地检查verify-release:对面向发布的验证进行更完整的检查
例如,在Python项目中,您可能需要:
.zed/scripts/verify跑ruff check,ruff format --check,以及pytest -q.zed/scripts/verify-release全面覆盖,例如pytest --cov
默认的面向发布的覆盖范围入口点是:
.zed/scripts/verify-release这需要 pytest-cov 如果你用它来覆盖Python,它是可用的。
初始化特定语言的项目本身
AgentOps提供了工作流模板,但它不会取代您的语言或包管理器自己的项目初始化。
例如,对于一个Python项目 uv 您可以运行:
uv init然后添加项目所需的检查 .zed/scripts/verify 和 .zed/scripts/verify-release.
同样,对于其他生态系统,在要求代理进行有意义的更改之前,您应该使用生态系统期望的工具初始化实际项目。
创建一个 docs 目录并写草稿
对于v0.5.4工作流,创建一个 docs 在项目目录中编写一个草稿,例如:
docs/draft_0.1.0.md您在本草案中描述了:
- 目标
- 范围
- 约束
- 优先事项
- 阶段
- 可能的门票
你可以完全自己写草稿,也可以与人工智能代理一起对其进行改进。这两种方法都是有效的。
一个实用的模式是:
- 创建
docs/ - 用你已经知道的要求写一份初稿
- 请代理人帮助将草案细化为面向阶段的计划
- 如果有用,请使用代理维护衍生的计划工件,例如:
- docs/__version__/plan.md - docs/__version__/tickets_list.json - docs/__version__/pX-tY.json
- 在工作进行过程中,将这些计划文件用作工作流程指导
思考规划流程的一个有用方法是:
draft.md是描述问题、目标、范围、约束和优先级的地方plan.md是将草案转化为分阶段执行指南的地方吗tickets_list.json是您打算处理的门票的简明索引pX-tY.json文件是输入、输出、验收标准和注释的每张票详细记录的可选文件
如果您维护工单工件,一个实用的状态集是:
plannedin-progresscheckingverifiedcommitteddoneblocked
重要v0.5.0边界:
- 计划文件下
docs/是有用的工作流工件 - 它们不是强制性的服务器管理协议状态
- 服务器不保证为您生成、同步或验证这些规划工件
- 如果你选择维护它们
tickets_list.json每张票文件同步是推荐的操作实践
它们最好被理解为用户或客户端管理的工作流文档。
从旧版本更新
如果您已经使用Zed AgentOps,请运行:
zed-agentops-init --update
这将刷新面向用户的模板,特别是:
.rules.agent状态文件存在- 默认验证/任务模板(如适用)
建议在从旧模板移动时进行更新,因为最近的版本收紧了:
- 可恢复性行为
- 事务/状态对齐
- 工作流规则清晰度
- 模板/运行时一致性
在大多数情况下, --update 够了。
v0.5.0的新增功能
v0.5.0中面向用户的最重要变化是清晰度和可预测性。
1.记录的工作流程更接近实际支持的工作流程
v0.5.0的主要目标是减少以下内容之间的不匹配:
.rules- 生成的模板
- 运行时服务器行为
- 协助工具
- 面向发布的文档
作为用户,这意味着记录的工作流比以前更值得信赖。
2.票证文件是惯例,不是服务器协议
如果您继续计划以下文件:
docs/__version__/plan.mddocs/__version__/tickets_list.jsondocs/__version__/pX-tY.json
它们是有用的工作流文档,但它们不是规范的服务器管理状态。
在实践中:
- 您可以手动维护它们
- 你可以和代理人一起维护它们
- 但您不应该假设服务器会自动创建、同步或验证它们
3.规范的本地工作流状态处于 .agent/
对于实际使用,最重要的规范工件是:
.agent/tx_event_log.jsonl.agent/tx_state.json
交接和计划文档很有帮助,但它们不是规范的工作流程记录。
4.提交工作流更加明确
支持的流程更严格:
- 提交前验证
- 没有更改时不提交
这减少了意外的空提交或未经验证的提交。
5.文件意图工作流程更易于安全使用
支持的辅助曲面现在包括:
ops_add_file_intentops_update_file_intentops_complete_file_intent
这些助手使常见的文件意图工作流更容易遵循,而不会削弱规范的事务规则。
6.Bootstrap状态更容易推理
一开始 .agent/tx_state.json 基线更加规范化,因此用户和客户端不太可能将缺失的字段误读为模糊的旧模板行为。
7.版本概念有意不同
你可能会看到不同的版本概念,它们并不都意味着同一件事:
- 包/服务器版本
- 事务/模式版本
- 草案/发布计划版本
这是意料之中的。不要假设文档版本标签自动与持久事务模式版本相同。
为用户提供实用建议
对于v0.5.0中的日常使用:
- 保持模板的最新状态
zed-agentops-init --update在需要时 - 对待
.agent/tx_state.json和.agent/tx_event_log.jsonl作为规范的本地工作流状态 - 按以下方式处理计划文件
docs/作为有用的约定,不保证服务器协议 - 扩展
verify和verify-release以匹配您的项目 - 更喜欢小的、范围明确的草稿
docs/在大型代理驱动工作之前 - 期望代理工作流遵循初始化→ 改变→ 验证→ 比以前更严格地承诺
有关支持的v0.5.0客户端/服务器契约的更完整的面向版本的解释,请参阅 docs/v0.5.0/interoperability.md.
备注
- 目前仅限macOS
- 生成的模板旨在根据存储库进行定制
- 默认的验证脚本是有意保守的,可能需要添加特定于项目的内容
- v0.5.0工作流区分了强制协议行为和用户管理的工作流惯例;这种区别是有意的
许可证
麻省理工学院
