用途
sync-plugin-skills 用于同步插件技能文档与当前实现、README.md 以及 guides 文件夹,确保 plugins/synapse-a2a/skills/ 下的技能内容准确反映项目的实际状态。
主要能力
该技能围绕以下目标运作:
- 确保技能内容准确反映 synapse/ 目录中的当前实现
- 确保技能内容与 README.md 文档保持一致
- 确保技能内容与 guides/ 文件夹中的指南保持一致
使用方式
何时使用
- 在实现新功能或参数之后
- 在更新 README.md 或 guides 之后
- 在发布新版本之前
- 当 /sync-plugin-skills 被调用时
工作流程
第 1 步:收集当前状态
读取以下文件以了解当前实现与文档:
实现文件:
- synapse/tools/a2a.py - CLI 工具实现
- synapse/a2a_client.py - A2A 客户端
- synapse/cli.py - 主 CLI 入口
- synapse/commands/*.py - 命令实现
文档文件:
- README.md - 主文档
- guides/usage.md - 使用指南
- guides/settings.md - 设置文档
当前技能文件:
- plugins/synapse-a2a/skills/synapse-a2a/SKILL.md
- plugins/synapse-a2a/skills/synapse-a2a/references/*.md
第 2 步:识别差距
对比并识别以下内容:
- 技能中未记录的新 CLI 选项/参数
- 已变更的命令语法或行为
- README 中提到但技能中缺失的新功能
- 技能中仍保留的已弃用或已移除功能
- 端点路径不一致
第 3 步:更新技能
更新技能文件以匹配当前状态:
synapse-a2a/SKILL.md:
- 快速参考表
- 命令示例
- 功能描述
synapse-a2a/references/commands.md:
- 完整 CLI 命令文档
- 所有选项与参数
- 示例用法
synapse-a2a/references/api.md:
- 端点路径
- 请求/响应格式
- 扩展端点
第 4 步:验证一致性
确保以下方面保持一致:
- 端点路径在 README 与技能之间匹配
- 命令语法完全相同
- 选项名称与默认值与实现匹配
- 示例使用正确语法
需要检查的关键区域
命令选项
# 检查 synapse/tools/a2a.py 中的当前选项
synapse send <target> <message> [options]
需要验证的关键选项:
- --from / -f:发送者标识
- --priority / -p:优先级(1-5)
- --wait / --notify / --silent:响应模式控制
- --reply-to:回复特定任务
API 端点
/.well-known/agent.json # Agent Card
/tasks/send # 标准 A2A
/tasks/send-priority # Synapse 扩展
/tasks/{id} # 任务状态
/status # 代理状态
设置命令
synapse init # 初始化 .synapse/
synapse config # 交互式 TUI
synapse config show # 查看设置
synapse reset # 重置为默认值
输出
同步完成后,报告:
- 已更新的文件
- 所做的具体更改
- 任何需要手动审查的内容
限制与注意事项
- 保留技能文件结构(YAML frontmatter + markdown)
- 保持描述简洁且可操作
- 对指令使用命令式形式
- 避免在 SKILL.md 与 references/ 之间重复内容