mcpField
S
sync-plugin-skills

sync-plugin-skills

github.com/s-hiraokuAgent 工作流1756 次安装2 周前更新
代码仓库

关于 sync-plugin-skills

用于让 synapse-a2a 插件技能文件与 Synapse 实现及文档保持一致的维护技能。它指导 Agent 检查差异、更新参考文档并验证内容，适用于功能变更后或发布前。

主要功能

  1. 01对照实现与文档
  2. 02查找技能内容的缺漏或过时项
  3. 03更新命令和 API 参考
  4. 04核对语法、选项与端点

适用场景

  1. 01添加 CLI 选项或功能后
  2. 02更新 README 或指南后
  3. 03发布新版本前

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/s-hiraoku/synapse-a2a --skill sync-plugin-skills

安装后在 Claude Code 中输入/sync-plugin-skills确认已加载。

详细介绍

同步插件技能

将插件技能与当前实现和文档同步。

目的

确保 plugins/synapse-a2a/skills/ 中的技能准确反映：

  • synapse/ 目录中的当前实现
  • README.md 文档
  • guides/ 文件夹中的指南

适用时机

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

工作流

步骤 1：收集当前状态

阅读以下文件，了解当前实现和文档：

  1. 实现：synapse/ 中的关键文件

    • synapse/tools/a2a.py - CLI 工具实现
    • synapse/a2a_client.py - A2A 客户端
    • synapse/cli.py - 主 CLI 入口
    • synapse/commands/*.py - 命令实现

  2. 文档：

    • README.md - 主文档
    • guides/usage.md - 使用指南
    • guides/settings.md - 设置文档

  3. 现有技能：

    • 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 与技能文档中的端点路径相符
  • 命令语法完全一致
  • 选项名称和默认值与实现相符
  • 示例使用正确的语法

需要检查的关键领域

命令选项
# Check synapse/tools/a2a.py for current options
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                # Standard A2A
/tasks/send-priority       # Synapse extension
/tasks/{id}                # Task status
/status                    # Agent status
设置命令
synapse init               # Initialize .synapse/
synapse config             # Interactive TUI
synapse config show        # View settings
synapse reset              # Reset to defaults

输出

同步完成后，报告：

  1. 已更新的文件
  2. 所做的具体更改
  3. 需要人工审核的事项

注意事项

  • 保留技能文件结构（YAML frontmatter + Markdown）
  • 保持描述简洁且可执行
  • 指令使用祈使语气
  • 避免在 SKILL.md 与 references/ 之间重复内容

评论

支持 Markdown