先列出用户期望您的插件完成的任务。插件的名称、描述、技能、工具,以及它与现有产品的连接方式,都会影响用户的预期。插件的实现应满足这些预期。如果您决定不支持某项任务,应有明确的理由。
根据这些任务,确定插件需要哪些组成部分:
- 如果指令、示例或随插件提供的资源可以引导模型完成工作流程,请添加技能。
- 如果工作流程需要实时数据、身份验证、受控工具,或需要在您运营的基础设施上运行代码,请添加 MCP 服务器。
- 只有在可视化交互能明显改善工作流程中的某个环节时,才为 MCP 服务器添加用户界面。
从用户预期出发
设想一位用户已经安装了您的插件,但还没读过文档。这位用户有理由期待插件完成哪些任务?
您可以从以下几个方面收集用户可能提出的请求:
- 用户已经在您的产品或服务中完成的任务。
- 用户访谈、支持请求、搜索查询和功能需求。
- 用户谈到您的产品、数据和工作流程时常用的词语。
- 用户目前采用的、需要在工具之间复制数据的变通办法。
- 插件名称、插件详情页和入门提示。
既要收集点名插件的直接请求,也要收集只描述目标的间接请求。例如,项目管理插件可能既要能处理“给我看看我的 Acme 发布看板”,也要能回答“哪些问题阻碍了发布?”
构思用例时,不要只考虑现有 API 能支持的工作流程。先记录用户的预期,再逐项评估哪些任务是您能安全、可靠地支持的。
建立用例清单
为每个用例记录以下内容:
| 字段 | 需要回答的问题 |
|---|---|
| 用户目标 | 用户想完成什么任务? |
| 请求示例 | 用户可能会怎样直接或间接地提出请求? |
| 预期结果 | 得到什么结果才算这次交互成功? |
| 所需上下文 | 需要哪些信息或账户访问权限?开始前需要满足哪些状态条件? |
| 插件能力 | 技能能否完成这项任务,还是需要 MCP 工具? |
| 安全边界 | 这项操作是否可能暴露数据、改变状态、产生支出或影响他人? |
| 支持计划 | 首个版本会支持这个用例、推迟支持,还是明确将其排除? |
将目标相同的请求归为一组。例如,“列出我还没完成的任务”“我今天要做什么?”和“给我看看已逾期的任务”可能都属于查看任务这一用例,只是筛选条件不同,无需拆成三个互不相关的功能。
检查用例覆盖情况
对照计划提供的插件功能,逐项检查用户预期:
- 确认每个计划支持的用例都有完整流程,从接收请求一直到给出有用的结果。
- 找出缺少的技能、工具、数据或权限,以及尚未处理的错误状态。
- 检查是否有工具只提供底层技术操作,却无法帮助用户达成明确的目标。
- 确认写入操作包含适当的授权和确认步骤。
- 检查插件能否说明自己无法完成哪些任务,并给出有用的下一步建议。
如果插件只能完成用户预期工作流程中的一小部分,就不应让用户以为它能处理整个流程。例如,如果用户可以创建项目,却无法列出、查看或更新项目,您应补齐这些功能,或缩小插件对外宣称的功能范围。
记录明确排除的用例
您无需实现每一种能想到的请求,但每排除一个重要用例,都应有充分的理由,例如:
- 该操作会带来不可接受的安全或隐私风险。
- 底层产品或 API 无法可靠地支持该操作。
- 工作流程需要某些权限,而插件无法验证用户是否具备这些权限。
- 插件无法访问所需的信息,缺少这些信息会使结果产生误导。
- 该用例超出首个版本的支持范围,插件详情页也已向用户说明这一点。
记录这些决定。在界定技能的适用范围、编写工具描述、设计插件拒绝请求时的行为、编写测试用例和撰写插件公开详情页文案时,都应以这些决定为依据。
根据用例选择实现方式
对于每个计划支持的用例,选择足以完成任务的最简单实现方式:
- 如果需要可重复使用的指令和资源,请构建技能。
- 如果需要实时数据和受控操作,请构建 MCP 服务器。
- 如果用户需要查看、比较、编辑、确认或浏览结构化信息,请为 MCP 服务器添加用户界面。
保留用例清单,用作测试计划。在清单中加入有代表性的直接请求、间接请求、涉及边界情况的请求和超出支持范围的请求。插件开发完成后,逐项验证其行为是否符合预期。
如果插件需要实时数据或受控操作,请继续阅读定义工具。