SuperAPI AI 工具集

develop-fastgpt-plugin

测试与质量

查看项目

更新于 10-15 23:48

技能介绍

用途:把插件想法落地为可用的 FastGPT 官方插件,先确保本机具备仓库、工具与依赖,再脚手架创建并实现插件。

环境准备:确认位于仓库内(git rev-parse --show-toplevel、git remote -v、检查 package.json 名称为 @fastgpt/official-plugins,上游为 labring/fastgpt-official-plugins)。所需工具:git、gh、node、corepack、pnpm;Node.js >=22,pnpm >=10(建议 pnpm@10.28.2)。缺失 gh 时按官方说明安装(macOS 用 brew install gh,Windows 用 winget install --id GitHub.cli),并运行 gh auth login 与 gh auth status。

克隆与稀疏检出:先选插件路径(默认 PLUGIN_DIR=packages/tools/<plugin-name>),用 gh repo fork 与 --filter=blob:none --sparse 只检出根文件与目标目录;已克隆仓库则确保 upstream 指向官方仓库并执行 sparse-checkout。安装依赖:corepack enable、corepack prepare pnpm@10.28.2 --activate、pnpm install,随后创建分支 git checkout -b codex/<plugin-name>。

插件工作流:收集插件名与目录、类型(tool 或 tool-suite)、中英文名与描述、输入输出、密钥、外部 API、预期行为与 1-3 个测试示例。信息不足时最多问三个聚焦问题。脚手架前阅读 node_modules/@fastgpt-plugin/cli/skills/cli-usage/SKILL.md,创建骨架用 pnpm fastgpt-plugin create <plugin-name> --type tool --cwd packages/tools --description "<description>"(tool-suite 类似)。再从生成目录解析 @fastgpt-plugin/sdk-factory 的技能文件(fastgpt-plugin-development、fastgpt-system-tool-development、fastgpt-sdk-factory),作为实现规则的权威依据;若与仓库技能冲突,实现细节以 SDK 技能为准。

验证:在插件目录运行 pnpm test、pnpm build、npx @fastgpt-plugin/cli check --entry . --output ./dist、pnpm pack。若脚本不同,读取 package.json 使用本地脚本;共享改动后可运行根级 pnpm type-check 或 pnpm biome-check。注意保持 origin 指向个人 fork、upstream 指向官方仓库,优先复用附近插件工具,最终报告改动文件、验证命令与未验证的外部 API 行为。