背景
docs/plugin-development.md 建议插件包含 schema validation、permission handling、error results、abort behavior 等合约测试。但仓库目前没有提供可复用的 contract test helper 或最小插件示例。插件作者如果要接入 Pixelle Tool API,需要自己拼装测试样板,容易遗漏权限、错误归一化、取消信号等关键边界。
随着 Tool API 被定位为稳定扩展边界,提供官方测试工具可以降低第三方工具接入成本,也能让插件作者更早发现与运行时约定不兼容的问题。
目标
增加面向插件作者的 contract test kit 和最小示例,帮助外部工具验证自己是否符合 Pixelle Tool API 的基本约定。
改动方向
提供一组可复用测试 helper,用于校验工具参数 schema、权限拒绝、结构化错误、成功结果和 abort 行为。需要明确这些 helper 的导出路径和稳定性:如果作为公共 API,应从合适入口导出;如果只作为测试示例,也要在文档中说明使用边界。
同时增加一个 minimal custom tool 示例,让插件作者能直接参考如何定义参数、检查权限、返回 ToolResult 并编写合约测试。
可能涉及模块
src/tool 公共导出
tests/tool
docs/plugin-development.md
docs/tool-api.md
README.md 或 README.zh-CN.md
- 示例工具或测试 fixture 目录
任务清单
验收标准
建议标签
feature、documentation、developer-experience
背景
docs/plugin-development.md建议插件包含 schema validation、permission handling、error results、abort behavior 等合约测试。但仓库目前没有提供可复用的 contract test helper 或最小插件示例。插件作者如果要接入 Pixelle Tool API,需要自己拼装测试样板,容易遗漏权限、错误归一化、取消信号等关键边界。随着 Tool API 被定位为稳定扩展边界,提供官方测试工具可以降低第三方工具接入成本,也能让插件作者更早发现与运行时约定不兼容的问题。
目标
增加面向插件作者的 contract test kit 和最小示例,帮助外部工具验证自己是否符合 Pixelle Tool API 的基本约定。
改动方向
提供一组可复用测试 helper,用于校验工具参数 schema、权限拒绝、结构化错误、成功结果和 abort 行为。需要明确这些 helper 的导出路径和稳定性:如果作为公共 API,应从合适入口导出;如果只作为测试示例,也要在文档中说明使用边界。
同时增加一个 minimal custom tool 示例,让插件作者能直接参考如何定义参数、检查权限、返回
ToolResult并编写合约测试。可能涉及模块
src/tool公共导出tests/tooldocs/plugin-development.mddocs/tool-api.mdREADME.md或README.zh-CN.md任务清单
plugin-development.md,说明如何使用 contract test kit验收标准
建议标签
feature、documentation、developer-experience