必须通过自定义工具函数桥接sonarqube api实现扫描结果汇总:先获取含analyze权限的token和项目key,再在dify中创建含参数校验与语义化输出逻辑的custom tool,配置白名单与调用权限后,结合prompt指令触发结构化中文报告生成。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

要在Dify中自动获取SonarQube服务器上多个项目的代码质量扫描结果,并生成可读性强、带问题归因和修复建议的中文汇总报告,必须绕过Dify原生不支持HTTP客户端直连的限制,借助自定义工具函数桥接外部API。
准备SonarQube API访问凭证与项目标识
登录SonarQube管理后台 → 点击右上角用户头像 → 选择【My Account】→ 切换到【Security】标签页 → 点击【Generate Tokens】→ 输入名称(如dify-sonar-sync)→ 点击【Generate】→ 复制生成的token字符串。该token需具备analyze权限,否则无法读取项目分析数据。
在SonarQube首页进入目标项目 → 地址栏URL末尾形如/dashboard?id=my-app-backend → 其中my-app-backend即为该项目的key,每个项目唯一,后续调用API时必须精确填写。
在Dify中创建自定义工具(Custom Tool)
进入Dify工作区 → 左侧导航栏点击【Tools】→ 右上角【+ Create Tool】→ 选择【Custom Tool】→ 填写工具名称为sonarqube_summary → 在Description中输入“获取SonarQube项目扫描摘要并结构化输出”。
在Parameters字段粘贴以下JSON Schema,注意project_key设为必填项,threshold_critical设为默认值5,表示当严重漏洞数≥5时触发高亮预警:
{"type":"object","properties":{"project_key":{"type":"string","description":"SonarQube中项目的唯一标识key"},"threshold_critical":{"type":"integer","default":5,"description":"严重问题数量阈值,用于判断是否需要重点提示"}},"required":["project_key"]}
在Action字段编写Python函数逻辑:先用requests.get请求https://your-sonarqube.com/api/measures/component?component={project_key}&metricKeys=bugs,vulnerabilities,code_smells,coverage,ncloc,再解析JSON响应中的measures数组,提取各指标值;若任意指标为空则返回错误字典;最后按预设模板拼接中文汇总文本,含“严重漏洞X个(建议立即修复)”等语义化描述。
【必须将SonarQube服务器域名加入Dify后端白名单,否则请求会被拦截】
配置工具调用权限与测试执行
保存自定义工具后,在当前Agent或Workflow编辑页 → 找到【Tools】配置区域 → 勾选刚创建的sonarqube_summary → 点击右侧【Test】按钮。
在弹窗中输入测试参数:
方法一:直接填写JSON对象{"project_key": "my-app-backend", "threshold_critical": 3}
方法二:使用表单模式输入
project_key → 填入my-app-backend
threshold_critical → 保持空值(自动采用默认5)
点击【Run】,观察返回结果是否包含类似“代码异味共42处,其中严重漏洞7个(建议立即修复),覆盖率68.3%(低于团队基线75%)”的自然语言段落。若返回Connection refused或Unauthorized,检查token有效性及网络策略。
在Prompt中嵌入工具调用指令
第一步:在Agent的System Prompt末尾添加说明:“你可调用sonarqube_summary工具获取指定项目的静态扫描摘要,调用前必须确认用户已提供项目key。”
第二步:在User Prompt中明确触发条件,例如:“请汇总项目‘payment-service’最近一次扫描结果,并指出最需优先处理的问题类型。”
第三步:确保Dify工作流中启用【Auto Tool Calling】,且工具调用超时设为30秒——SonarQube API响应通常在3~8秒,设太短会导致失败重试,设太长会阻塞对话流。
大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!










