document/content/plugin/system-tool-development.mdx
本文面向 FastGPT v4.15.0 之后的系统工具开发。新版 FastGPT Plugin 服务把系统工具、模型预设等能力统一抽象为可安装、可更新、可运行隔离的插件包,插件最终以 .pkg 文件交付给 FastGPT Plugin 服务。
当前稳定支持的系统工具插件类型有两种:
defineTool() 声明。defineToolSet() 声明。系统工具插件运行在 FastGPT Plugin 服务提供的运行时中。FastGPT 主服务通过插件服务调用工具,插件代码通过 @fastgpt-plugin/sdk-factory 描述输入、输出、密钥配置和执行逻辑。
.pkg 格式,便于安装、版本管理、热更新和后续扩展其他插件类型。local-pool,每个插件版本拥有独立进程池、队列和运行时配置。@fastgpt-plugin/cli 和 @fastgpt-plugin/sdk-factory,不再以旧版 config.ts、versionList 和 bun run build:pkg 作为主要开发方式。开始编码前先明确这些信息:
| 信息 | 说明 |
|---|---|
| 插件类型 | tool 或 tool-suite。 |
| 插件 ID | pluginId,全局稳定唯一,发布后保持不变。 |
| 子工具 ID | 工具集需要,children[].id 发布后保持不变。 |
| 中英文名称 | name.en 和 name.zh-CN。 |
| 中英文描述 | description.en 和 description.zh-CN。 |
| 输入 | 每个字段的类型、约束、默认值、UI 标题和说明。 |
| 输出 | 每个字段的类型、含义和下游使用方式。 |
| 密钥 | API Key、Base URL、账号密码等,通过 secretSchema 描述。 |
| 外部 API | 请求方式、鉴权方式、超时、限流、错误响应和测试账号。 |
| 文件能力 | 需要上传文件时使用 ctx.invoke.uploadFile()。 |
| 流式输出 | 需要展示中间进度时使用 ctx.streamResponse()。 |
| 测试样例 | 至少包含成功路径、参数错误、鉴权失败和上游失败。 |
影响插件 ID、鉴权方式、计费或上架安全性的信息需要先确认。其他信息可以使用合理默认值继续推进,并在提交说明中记录假设。
使用 Claude Code、Codex 或其他 Agent 工具时,可直接复制下面的提示词:
请根据以下 FastGPT 官方插件开发 Skill 开发插件:
https://raw.githubusercontent.com/labring/fastgpt-official-plugins/refs/heads/main/.agents/skills/develop-fastgpt-plugin/SKILL.md
执行要求:
1. 先读取并理解该 Skill 的完整内容,后续开发流程以该 Skill 为准。
2. 在开始编码前,收集插件名称、插件类型、中文/英文名称与描述、输入输出、密钥、外部 API、预期行为、错误处理和测试样例。
3. 如需求缺失,最多提出 3 个关键问题;如果可以合理默认,说明假设后继续推进。
4. 使用 `@fastgpt-plugin/cli` 创建插件骨架,并优先遵循仓库内已有插件的结构、命名、测试和构建方式。
5. 实现完成后运行必要验证,包括测试、构建、插件检查和打包;无法验证的项目需要说明原因。
6. 最终输出变更文件、验证结果、剩余假设和需要人工确认的外部 API 行为。
在 fastgpt-plugin 仓库内开发或维护 SDK/CLI 时,也可以参考本地 Skill:
sdk/factory/skills/fastgpt-plugin-development/SKILL.mdsdk/factory/skills/fastgpt-system-tool-development/SKILL.mdsdk/factory/skills/fastgpt-sdk-factory/SKILL.md推荐环境:
pnpm,当前 fastgpt-plugin 仓库使用 pnpm workspace。gh,用于 fork、创建仓库和提交 PR。开发社区插件时,先 fork 并 clone 社区插件仓库:
gh repo fork labring/fastgpt-community-plugins --clone
cd fastgpt-community-plugins
pnpm install
在 fastgpt-plugin 仓库内调试 CLI 或 SDK 时,先安装依赖并构建 CLI/SDK:
pnpm install
pnpm build:sdk-factory
pnpm build:cli
单工具插件:
pnpx @fastgpt-plugin/cli create my-tool --type tool --cwd packages/tools
工具集插件:
pnpx @fastgpt-plugin/cli create my-tool-suite --type tool-suite --cwd packages/tools
也可以进入目标目录后交互式创建:
pnpx @fastgpt-plugin/cli create
CLI 会创建插件目录,并生成常见文件:
| 文件 | 作用 |
|---|---|
index.ts | 插件入口,默认导出 defineTool() 或 defineToolSet()。 |
package.json | 插件依赖和 build、build:dev、pack、test 脚本。 |
tsconfig.json | TypeScript 配置。 |
vitest.config.ts | 测试配置。 |
README.md | 插件说明。 |
logo.svg | 插件主图标。 |
系统工具入口必须默认导出 SDK factory 实例:
import {
createToolHandler,
defineTool,
type InputSchemaMetaType,
type OutputSchemaMetaType,
type SecretSchemaMetaType
} from '@fastgpt-plugin/sdk-factory';
import z from 'zod';
const secretSchema = z.object({
apiKey: z
.string()
.min(1)
.meta({
title: 'API Key',
isSecret: true
} satisfies SecretSchemaMetaType)
});
const handler = createToolHandler({
inputSchema: z.object({
query: z
.string()
.min(1)
.meta({
title: 'Query',
description: 'Search keyword'
} satisfies InputSchemaMetaType)
}),
outputSchema: z.object({
result: z.string().meta({
title: 'Result'
} satisfies OutputSchemaMetaType)
}),
secretSchema,
handler: async (input, ctx) => {
return {
result: input.query
};
}
});
export default defineTool({
manifest: {
pluginId: 'example-search',
version: '1.0.0',
name: {
en: 'Example Search',
'zh-CN': '示例搜索'
},
description: {
en: 'Search example data',
'zh-CN': '搜索示例数据'
},
versionDescription: {
en: 'Initial version',
'zh-CN': '初始版本'
},
tags: ['tools']
},
handler
});
核心规则:
pluginId、子工具 id、输入字段名、输出字段名发布后保持稳定。manifest.name、manifest.description 和 versionDescription 使用 { en, 'zh-CN' }。InputSchemaMetaType,输出字段补充 OutputSchemaMetaType。SecretSchemaMetaType,敏感字段设置 isSecret: true。outputSchema。ctx.invoke.uploadFile(),并优先保留返回的 err。ctx.streamResponse()。工具集使用 defineToolSet(),把共用信息放在顶层 manifest 和 secretSchema,每个子工具在 children 中声明独立 id、名称、描述和 handler。
import {
createToolHandler,
defineToolSet,
type InputSchemaMetaType,
type OutputSchemaMetaType,
type SecretSchemaMetaType
} from '@fastgpt-plugin/sdk-factory';
import z from 'zod';
const secretSchema = z.object({
apiKey: z.string().meta({
title: 'API Key',
isSecret: true
} satisfies SecretSchemaMetaType)
});
const searchHandler = createToolHandler({
inputSchema: z.object({
query: z.string().meta({
title: 'Query'
} satisfies InputSchemaMetaType)
}),
outputSchema: z.object({
items: z.array(z.string()).meta({
title: 'Items'
} satisfies OutputSchemaMetaType)
}),
secretSchema,
handler: async (input) => ({ items: [input.query] })
});
const summaryHandler = createToolHandler({
inputSchema: z.object({
content: z.string().meta({
title: 'Content'
} satisfies InputSchemaMetaType)
}),
outputSchema: z.object({
summary: z.string().meta({
title: 'Summary'
} satisfies OutputSchemaMetaType)
}),
secretSchema,
handler: async (input) => ({ summary: input.content.slice(0, 100) })
});
export default defineToolSet({
manifest: {
pluginId: 'text-tools',
version: '1.0.0',
name: {
en: 'Text Tools',
'zh-CN': '文本工具集'
},
description: {
en: 'Search and summarize text',
'zh-CN': '搜索和总结文本'
}
},
children: [
{
id: 'search',
name: { en: 'Search', 'zh-CN': '搜索' },
description: { en: 'Search text', 'zh-CN': '搜索文本' },
toolDescription: 'Search text by query',
handler: searchHandler
},
{
id: 'summary',
name: { en: 'Summary', 'zh-CN': '总结' },
description: { en: 'Summarize text', 'zh-CN': '总结文本' },
toolDescription: 'Summarize text content',
handler: summaryHandler
}
],
secretSchema
});
CLI 构建时会扫描插件根目录中的图标并写入构建后的 manifest.json。
| 场景 | 文件名 |
|---|---|
| 主插件图标 | logo.svg、logo.png、logo.jpg、logo.jpeg、logo.webp 或 logo.gif |
| 工具集子工具图标 | <childId>.logo.svg、<childId>.logo.png 等 |
注意事项:
<childId> 与 children[].id 完全一致。dist/manifest.json 中的 icon 字段。先进入插件目录安装依赖:
cd packages/tools/my-tool
pnpm install
查看插件和可调试工具信息:
pnpx @fastgpt-plugin/cli debug .
执行一次单工具调试:
pnpx @fastgpt-plugin/cli debug . --run --input '{"query":"hello"}' --secrets '{"apiKey":"test"}'
执行工具集中的某个子工具:
pnpx @fastgpt-plugin/cli debug . --run --tool search --input '{"query":"hello"}' --secrets '{"apiKey":"test"}'
输入、密钥和系统变量较大时,使用文件传入:
pnpx @fastgpt-plugin/cli debug . --run --input-file input.json --secrets-file secrets.json --system-var-file system-var.json
本地 debug 的边界:
ctx.invoke.uploadFile() 使用本地虚拟实现,默认输出到 .fastgpt-plugin-debug/uploads。远程调试用于把本地正在开发的插件接入 FastGPT 测试环境。FastGPT 页面负责鉴权并生成调试链接,CLI 通过该链接建立 WSS 调试通道;调试插件仅对当前调试者本人可见。
使用前确认测试环境已部署 FastGPT Plugin 服务和 Connection Gateway,并且本地开发机可以访问测试环境返回的 Gateway WSS 地址。
调试链接只用于本地 CLI 连接测试环境,不应提交到代码仓库、文档示例或聊天记录中。
在插件目录或包含多个插件目录的工作区中运行:
fastgpt-plugin dev
启动后,将 FastGPT 页面复制的调试链接粘贴到 TUI 中。CLI 会用链接中的 connection key 换取短期 WSS connect token,并把本地插件挂载到 FastGPT 的调试通道。
脚本或 Agent 场景可以使用非交互模式:
fastgpt-plugin dev --no-interactive \
--connect "https://fastgpt.example.com/api/plugin/debug-channel/connection-key:exchange?connectionKey=fpg_dbg_..."
如果只传入裸 connection key,需要让 CLI 知道 exchange 接口地址:
FASTGPT_PLUGIN_DEBUG_CONNECT_URL=https://fastgpt.example.com/api/plugin/debug-channel/connection-key:exchange \
fastgpt-plugin dev --no-interactive --connect "fpg_dbg_..."
--connect 成功连接后会保存 connection key,后续可直接运行 fastgpt-plugin dev 复用本地配置。TUI 中按 c 可重新输入并保存新的调试链接或 connection key。
dev 未传插件目录时会自动探测当前目录:当前目录存在 index.ts 时使用当前目录;否则扫描下一层子目录中的 index.ts。
也可以手动传入一个或多个插件目录:
fastgpt-plugin dev ./plugins/getTime ./plugins/dbops --watch
--watch 会在本地文件变化后重新加载插件并重建远程调试会话。CLI 默认开启断线重连;如需关闭自动重连,可加 --no-reconnect。
CLI 显示远程调试已就绪后,回到 FastGPT 测试环境:
调试工具的 source 会绑定到当前登录成员,其他成员默认看不到该调试插件。
本地终端按 Ctrl+C 会关闭当前 CLI 调试会话;再次按 Ctrl+C 会强制退出。
FastGPT 页面中的「结束调试」会撤销当前成员的 debug channel,并清理页面上的调试插件入口。调试链接泄露、成员切换或需要重新授权时,优先使用「刷新链接」生成新链接。
插件目录中通常可以直接运行:
pnpm run test
pnpm run build
pnpx @fastgpt-plugin/cli check --entry . --output ./dist
pnpm run pack
也可以显式传入目录:
pnpx @fastgpt-plugin/cli build --entry packages/tools/my-tool --output packages/tools/my-tool/dist --minify
pnpx @fastgpt-plugin/cli check --entry packages/tools/my-tool --output packages/tools/my-tool/dist
pnpx @fastgpt-plugin/cli pack --entry packages/tools/my-tool --dist ./dist --output packages/tools/my-tool/out
构建产物应包含:
dist/index.jsdist/manifest.jsonREADME.mdassets/**打包后会生成 .pkg 文件。上传、安装和上架都应使用该 .pkg 文件。
提交前至少确认:
index.ts 默认导出正确。manifest.pluginId、manifest.version、中英文名称和描述完整。children[].id 稳定且没有重复。inputSchema 覆盖所有用户输入,并有必要的类型和范围约束。outputSchema 与 handler 返回值一致。secretSchema 覆盖全部密钥配置,敏感字段设置 isSecret: true。pnpm run test 通过,或明确说明无法测试的原因。build、check、pack 通过。dist/manifest.json 中图标和 schema 符合预期。.pkg 能在测试环境中安装并完成真实调用。社区插件通常先在插件目录创建并推送独立 GitHub 仓库:
cd packages/tools/my-tool
git init
git add .
git commit -m "feat: add my-tool plugin"
gh repo create --public --source=. --remote=origin --push
然后回到 fastgpt-community-plugins 仓库,提交 submodule 或引用更新,并向 labring/fastgpt-community-plugins 提 PR。
官方插件需要完成:
.pkg。商业插件发布到私有仓库,按客户交付流程管理版本、密钥、安装包和验收记录。对外部 API、客户私有地址和账号密钥的处理需要单独记录安全边界。
如无需官方收录,可参考 上传系统工具 在自己部署的 FastGPT 中使用。
tool 和 tool-suite 如何选择?单一能力使用 tool。多个共享鉴权、共享上游 API、业务上强相关的能力使用 tool-suite,例如搜索、详情、创建任务放在同一个插件中。
manifest.version 使用语义化版本。修复兼容性问题升级 patch,新增兼容功能升级 minor,修改输入输出字段、子工具 ID 或用户配置方式时升级 major,并提前评估已有工作流兼容性。
插件应通过 secretSchema 声明密钥,并通过 ctx.secrets 读取。代码仓库、测试快照、错误日志和 README 中都不应出现真实密钥。
需要。本地 debug 用于快速验证插件逻辑和 schema,测试环境验证用于确认真实安装、运行时、宿主反向调用、网络和权限行为。