mcpField
C
create-output-format

create-output-format

github.com/leeoveryAgent 工作流2636 次安装1 天前更新
代码仓库

关于 create-output-format

create-output-format 是用于 workflow-planning-process 工作流的格式适配器脚手架技能。它引导收集工具资料、按五个关注点编写文件,并注册和验证新格式。

主要功能

  1. 01收集工具文档与需求
  2. 02按模板生成五个适配器文件
  3. 03注册新输出格式
  4. 04验证文件和内容要求

适用场景

  1. 01为任务管理工具添加输出格式
  2. 02根据文档编写任务读写说明
  3. 03检查适配器文件是否符合约定

安装

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

$npx skills add https://github.com/leeovery/agentic-workflows --skill create-output-format

安装后在 Claude Code 中输入/create-output-format确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

references/
contract.md
references/scaffolding/
about.md
authoring.md
graph.md
reading.md
updating.md

详细介绍

创建输出格式

为 workflow-planning-process 工作流搭建一个新的输出格式适配器脚手架。每个格式适配器都是一个包含 5 个文件的目录,每个文件对应一个关注点。

第 1 步:收集信息

在编写任何内容之前,先了解该工具。向用户询问:

  1. 这个工具/系统叫什么名字?
  2. 文档链接——官方文档、API 参考、MCP 服务文档,任何相关内容

如果用户已提前提供这些信息,直接跳到调研环节。

调研

使用 WebFetch 获取并阅读所有提供的文档。从文档中确定:

  • 任务是如何存储的(API、数据库、文件等)
  • 如何与之交互(MCP 服务、REST API、命令行工具、文件系统)
  • 如何创建、读取、更新和查询任务
  • 支持哪些任务属性——状态值、优先级级别、标签/标记、估算
  • 是否支持阻塞/依赖关系(项目内以及跨项目)
  • 各概念如何映射——什么代表项目、阶段、任务、依赖?
  • 需要哪些设置或配置
  • 相较更简单方案的优势与取舍
  • 任何约束或限制
澄清空白

将你了解到的情况以摘要形式呈现,请用户确认或纠正。使用 AskUserQuestion 澄清文档未涉及或表述含糊的内容——选择该格式的动机、多种接口并存时的首选接口、设置细节等。

根据工具名称建议一个 kebab-case 格式键,并与用户确认。

在用户确认你的理解之前,不要继续。

第 2 步:理解契约

阅读 references/contract.md——它定义了每个格式都必须实现的 5 文件接口。

第 3 步:创建格式目录

在以下位置创建目录:

skills/workflow-planning-process/references/output-formats/{format-key}/

第 4 步:编写文件

使用第 1 步收集的信息,编写全部 5 个必需文件。使用 references/scaffolding/ 中的脚手架模板作为结构指南:

模板生成
about.md{format}/about.md
authoring.md{format}/authoring.md
reading.md{format}/reading.md
updating.md{format}/updating.md
graph.md{format}/graph.md

对于每个文件:

  1. 从脚手架模板结构开始
  2. 将所有 {placeholder} 占位符替换为你收集到的格式专属内容
  3. 移除模板指导注释(以 `` 开头的行)
  4. 包含具体的命令、API 调用或 MCP 操作——而非含糊的描述

第 5 步:注册格式

按照现有模式,向 skills/workflow-planning-process/references/output-formats.md 添加一个条目:

### {Format Name}
format: `{format-key}`

adapter: [{format-key}/](output-formats/{format-key}/)

{One-line description of the format.}

- **Pros**: ...
- **Cons**: ...
- **Best for**: ...

第 6 步:验证

验证:

  • 目录中恰好包含 5 个文件:about.md、authoring.md、reading.md、updating.md、graph.md
  • 所有 {placeholder} 占位符均已替换
  • About.md 包含结构映射表
  • Authoring.md 记录了任务属性:状态、阶段分组、标签(不包含优先级或依赖)
  • Authoring.md 包含完整的任务创建示例
  • Reading.md 说明了如何使用状态、优先级、依赖和阶段来确定下一个任务的排序
  • Updating.md 涵盖了所有状态转换以及如何修改任务属性
  • Graph.md 涵盖了优先级级别以及添加/移除依赖
  • 格式已在 output-formats.md 中注册

评论

支持 Markdown