SuperAPI AI 工具集

sync-plugin-skills

通用与其它

查看项目

更新于 10-16 13:56

技能介绍

用途

sync-plugin-skills 用于同步插件技能(plugins/synapse-a2a/skills/)与当前实现、README.md 以及 guides 文件夹,确保技能文档准确反映最新的实现与文档状态。

主要能力

  • 读取并理解 synapse/ 目录中的当前实现与文档
  • 比对技能文件与实现、README.md、guides/ 之间的差异
  • 识别文档缺口,包括未记录的新 CLI 选项与参数、变更的命令语法或行为、README 中提到但技能中缺失的新功能、技能中仍保留的已弃用或移除功能、端点路径不一致
  • 更新技能文件以匹配当前状态
  • 验证跨文档的一致性

使用方式

触发时机

  • 实现新功能或参数之后
  • 更新 README.md 或 guides 之后
  • 发布新版本之前
  • 调用 /sync-plugin-skills 时

工作流程

步骤 1:收集当前状态

读取以下文件以了解当前实现与文档:

实现(synapse/ 中的关键文件):

  • 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 - Agent 状态

设置命令:

  • synapse init - 初始化 .synapse/
  • synapse config - 交互式 TUI
  • synapse config show - 查看设置
  • synapse reset - 重置为默认值

输出

同步后报告:更新的文件、具体变更内容、需要人工审查的地方。

限制与注意事项

  • 保留技能文件结构(YAML frontmatter + markdown)
  • 保持描述简洁且可操作
  • 指令使用祈使形式
  • 避免在 SKILL.md 与 references/ 之间重复内容