SuperAPI AI 工具集

stitch-sdk-readme

编程与开发

查看项目

更新于 10-15 21:53

技能介绍

用途:为 @google/stitch-sdk 生成或更新 README,使文档随 SDK 演进保持准确,避免在文档中硬编码 API。

主要能力:提供一套 README 写法结构与校验规则。结构采用 Bookstore Test:先一句话说明库解决什么问题(而非库是什么),随即给出可运行代码(核心流程 project(id) → generate → getHtml),把安装、认证、配置放到首个代码示例之后;随后按复杂度渐进展示次要流程(列出现有项目/屏幕、编辑与生成变体、用单例 stitch.listTools()/stitch.callTool() 零配置调用、用 StitchToolClient 自定义 API key 与 base URL、通过 @google/stitch-sdk/ai 的 stitchTools() 接入 AI SDK),最后按类分节给出完整参考。安装命令分两条路径展示(先核心包,再 AI SDK 组合)。

如何从代码库取当前 API:不硬编码 API 面,调用时读取——公共导出见 packages/sdk/src/index.ts;领域类方法与签名见 sdk.ts、project.ts、screen.ts;生成的绑定见 packages/sdk/generated/domain-map.json 的 bindings[];手写方法(如 Screen.edit、Screen.variants)见类源文件;AI SDK 工具适配见 packages/sdk/src/ai.ts;工具 JSON Schema 见 packages/sdk/generated/src/tool-definitions.ts;工具客户端方法见 client.ts;错误码见 spec/errors.ts 的 StitchErrorCode;配置项见 spec/client.ts 的 StitchConfigSchema;代理配置见 proxy/core.ts。

校验与反模式:生成后检查十秒内能否理解用途、首屏是否有可运行示例、配置是否在示例之后、每个代码块是否可直接粘贴运行、参考资料是否覆盖 index.ts 全部导出、示例方法名与导入是否真实存在,以及三类使用方式(领域类脚本、StitchToolClient 智能体、stitchTools() AI SDK)是否都被记录。反模式包括以徽章/logo 开篇、以 Getting Started 为首节、只列功能无代码、使用“easy to use”等自我夸赞、长安装配置块先于用法、折叠核心 API 文档、硬编码 API。

适用场景与限制:适用于为该项目撰写或维护 README 的开发者;要求可访问上述代码库路径以获取真实 API。资料未提供具体安装以外的运行要求、支持平台、许可与收费信息。