Dify Agent 自定义工具 SDK 开发实操

P粉328763957

P粉328763957

2026-06-05

280人浏览

原创

必须使用dify-tools sdk编写符合openapi 3.0规范的工具,经打包上传后才能在dify agent中启用;手动构造请求或上传非法json会导致工具不可用。

☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

dify agent 自定义工具 sdk 开发实操 - php中文网

要在 Dify 平台为 Agent 添加能调用外部 API 的自定义工具,必须基于官方 Python SDK 编写符合 OpenAPI 3.0 规范的工具描述,并通过正确签名与注册流程接入工作流。直接上传未经校验的 JSON 或跳过 token 签名会导致工具在编排界面显示为“不可用”状态。

准备开发环境与依赖

创建独立虚拟环境并安装 Dify 官方工具 SDK:python -m venv dify-tool-envsource dify-tool-env/bin/activate(Windows 用 dify-tool-env\Scripts\activate)→ pip install dify-tools

这一步不能省略,dify-tools 是唯一支持自动注入 auth header 和 schema 校验的 SDK】,手动构造请求头或使用 requests 将无法通过 Dify 后端的工具签名验证。

编写工具逻辑函数

新建 weather_tool.py,定义一个接受 location: str 参数、返回天气数据字典的函数:

def get_current_weather(location: str) -> dict:
import requests
resp = requests.get(f"https://api.example.com/weather?q={location}")
return {"temperature": resp.json()["temp"], "condition": resp.json()["weather"]}

函数名必须是蛇形命名且不含空格或特殊符号;返回值必须是纯 Python 字典,不能含 datetime 对象或 requests.Response 实例——否则 SDK 序列化时会抛出 TypeError。

声明工具元信息与 OpenAPI Schema

方法一:使用 @tool 装饰器(推荐)

Dify 3.9.2
Dify 3.9.2

Dify 3.9.2更新重点增强系统安全性,引入 Chainguard 安全基础镜像并同步社区版 CVE 修复,同时优化 OpenSearch 向量存储兼容性、插件参数传输机制及 Helm 部署配置。新增工作流模型节点缓存能力,可减少重复凭证查询,显著提升复杂工作流初始化速度,为企业级 AI 应用提供更稳定、高效的运行体验。

下载

在函数上方添加装饰器并传入中文名称与描述:

from dify_tools import tool
@tool(name="查询实时天气", description="根据城市名获取当前温度和天气状况")
def get_current_weather(location: str) -> dict:
...

方法二:手动构造 OpenAPI 3.0 JSON Schema

创建 weather_schema.json,严格按 Dify 要求填写 name(英文小写)、descriptionparameters 中每个字段的 typedescription【parameters 必须是 object 类型,且 required 字段数组不能遗漏】,否则工具在 Dify 控制台中无法被选中配置。

打包并注册工具到 Dify

第一步:将工具文件与 schema(若未用装饰器)放入同一目录,确保无 .pyc 或 __pycache__;
第二步:执行命令 dify-tools pack --entry weather_tool:get_current_weather
第三步:命令成功后生成 weather_tool.zip
第四步:登录 Dify 控制台 → 进入「Agent」→「工具」→「上传自定义工具」→ 选择该 ZIP 文件。

上传后需等待约 10 秒,状态从“处理中”变为“已启用”才可拖入工作流节点。若卡在“处理中”,说明 ZIP 内结构不符合要求——常见原因是入口函数路径写错,例如写成 weather_tool.py:get_current_weather(多写了 .py)或函数名拼错。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

dify dify agent

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
Dify 本地部署与企业配置
Dify 本地部署与企业配置

本专题系统讲解 Dify 从零开始的本地部署方法与企业环境配置实践,涵盖 Docker 安装、依赖准备、数据库初始化、反向代理、参数调优、安全加固与多用户开通,帮助开发者与企业团队快速搭建稳定可用的 Dify 平台。

2026.06.05

72

15

Dify Agent智能体开发实战教程
Dify Agent智能体开发实战教程

本专题聚焦 Dify Agent 智能体的设计与开发,涵盖 Agent 模式选择、工具集成、提示词设计、多步推理、上下文记忆与多 Agent 协作,帮助开发者构建可执行复杂业务任务的智能体应用。

2026.06.05

96

15

Dify RAG知识库构建实战教程
Dify RAG知识库构建实战教程

本专题围绕 Dify RAG 知识库的全流程实践展开,从文档导入、分段切片、向量化到混合检索、重排优化与召回评估,帮助你打造高准确率、低幻觉的企业知识问答应用。

2026.06.05

110

15

墨刀AI提示词教学
墨刀AI提示词教学

本合集由PHP中文网精心整理,为您提供全面的墨刀AI提示词教学。内容涵盖高质量原型撰写公式与实操窍门,助您轻松掌握AI设计工具。无论是零基础入门还是进阶技巧,都能让您快速上手,大幅提升产品设计与协作效率。

2026.08.04

3

21

墨刀AI完整入门
墨刀AI完整入门

PHP中文网为您倾力打造墨刀AI保姆级入门指南完整版!本合集从零基础讲起,涵盖AI生成原型、提示词优化、图片转原型及多轮对话等核心功能。无论您是新手还是进阶用户,都能轻松掌握产品设计全流程。快来PHP中文网,一键解锁高效设计技巧,让想法即刻成型!

2026.08.04

1

20

墨刀AI进阶技巧
墨刀AI进阶技巧

本合集由PHP中文网精心整理,为您提供墨刀AI核心进阶策略指南。内容涵盖高效提示词写作、原型智能生成与微调、结构化导图制作及行业分析报告输出等实战技巧。助您轻松掌握AI设计工具,大幅提升产品设计与团队协作效率。

2026.08.04

3

14

火山引擎实名认证失败怎么办
火山引擎实名认证失败怎么办

火山引擎实名认证失败可能与证件信息填写错误、姓名或企业信息不一致、证件照片不清晰、营业执照状态异常、手机号验证失败或审核资料不完整有关。本专题整理个人认证、企业认证、资料上传、审核退回、重新提交和认证不通过的常见处理方法。

2026.08.04

2

10

火山引擎域名备案流程详解
火山引擎域名备案流程详解

火山引擎域名备案适合需要在火山引擎云服务器、对象存储、CDN或网站服务上绑定域名的用户参考。本专题整理备案入口、账号实名认证、备案类型选择、主体信息填写、网站信息提交、资料上传、初审核验、管局审核和备案失败排查,帮助用户完成网站上线前的备案流程。

2026.08.04

0

10

火山引擎DNS解析配置步骤
火山引擎DNS解析配置步骤

使用火山引擎DNS解析网站域名时,需要确认域名已完成管理接入,并正确配置服务器IP、CNAME地址或验证记录。本专题整理域名添加、记录类型选择、TTL设置、解析状态检查、备案和访问测试等流程,适合新手搭建网站时参考。

2026.08.04

0

10

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Dify零基础教程
Dify零基础教程

共0课时 | 100人学习

学习Agent,从Dify开始
学习Agent,从Dify开始

共0课时 | 95人学习

Dify 部署与运维指南
Dify 部署与运维指南

共0课时 | 0人学习