工具¶
1 功能概述¶
MaxKB 支持用户根据自身的业务需求，通过各种工具获取和查询数据、逻辑判断、信息提取或其它场景的操作并在应用编排时进行调用，以满足各种复杂的业务需求。
- 共享工具：系统管理员在【共享资源】中创建共享工具后，可以授权给指定工作空间。
- 全部工具：用户可以创建工具，其他用户资源授权后可以查看、使用和维护。
工具通过文件夹进行管理，根目录下可建立最多三级的子文件夹。每一级文件夹内均可创建相应的工具。文件夹支持资源授权，普通用户仅可查看被授权的文件夹，授权文件夹时支持授权文件夹下已有的子资源。
注意：共享资源为企业版 X-Pack 功能。
2 自定义工具¶
2.1 依赖安装¶
如果工具实现需要安装第三方依赖包，可在 MaxKB 容器中使用 pip 命令进行安装。
# 进入 MaxKB 容器中
docker exec -it maxkb bash
# pip安装第三方依赖，如 pymysql，执行下面命令
pip install pymysql
2.2 工具创建¶
点击【创建工具】，打开创建工具页面。
- 工具名称：工具的 logo 与工具名称，便于识别。工具 logo 在保存后可自定义上传。
- 描述：工具详细说明以及使用注意事项，会显示在高级编排应用的组件列表中。
- 启动参数：启用参数即工具运行的必要参数，例如 API Key 等。将启动参数与输入参数分离，在工作流中仅关注输入参数，同时也避免关键信息的泄露。
- 输入参数：工具的输入参数，参数的数据类别包括：string、int、float、array，可自定义赋值，也可引用参数。
- 函数内容：自定义编写 Python 工具代码，可以引用输入变量。
- 输出参数：Python 代码执行返回的结果。
Python 代码编写完成后，点击【调试】进行代码功能的验证。调试完成后，点击【创建】，即完成工具的创建。已创建成功的工具，默认状态为【已禁用】。
已启用的工具，可以在【高级编排应用】的中，点击【添加组件】->【工具】中，以添加组件的方式调用工具；也可通过【AI 对话】组件的【工具】进行调用。
3 创建 MCP¶
点击【创建 MCP】，打开创建 MCP 页面。
- MCP 名称：MCP 的名称与 Logo，便于识别。MCP 的 Logo 在保存后可自定义上传。
- 描述： MCP 详细说明以及使用注意事项。
- MCP Server Config：使用 JSON 格式填写 MCP Server 配置参数。通过 SSE/Streamable HTTP 协议调用 MCP 服务中的工具。
已创建成功的 MCP，默认状态为【已禁用】。开启 MCP 后，可以在【高级编排应用】->【AI 对话】的 MCP 中进行引用。
4 工具商店¶
工具商店是 MaxKB 系统中的一个功能模块，帮助用户扩展系统的功能。
工具商店中的工具主要分为系统内置工具和工具商店两部分：
系统内置：
- 联网搜索：提供 Web 搜索功能，如 Google Search、博查搜索、LangSearch 等，帮助用户快速从互联网获取信息。
- 数据库查询：支持连接不同类型的数据库并执行查询，如 MySQL 查询、PostgreSQL 查询等，方便用户管理和分析数据。
工具商店：用户可直接在商店中选择所需的工具，无需手动开发或进行复杂集成，可以显著提升工具的调用效率。
为了丰富工具商店资源，推动产品生态持续发展，MaxKB 诚挚邀请广大社区用户参与工具贡献，共享技术成果：
- 贡献路径：开发者可以按照官方提供的工具开发规范开发适用于 MaxKB 的工具（例如 API 对接类、本地功能类具等）；
- 提交方式：完成开发后，将工具代码提交至 GitHub 官方工具仓库，项目团队将按流程审核，通过后即可上架至 MaxKB 工具商店，供全体社区用户使用；
- 共建开发生态：社区贡献的工具不仅能帮助更多用户解决实际问题，也将促进 MaxKB 工具生态的多样化发展，形成“用户需求-工具开发-生态完善” 的正向循环。
内置工具添加后，在配置启动参数（例如数据库连接信息、API Key 等）并启用后，便可在高级编排应用中调用。
5 工具导出/导入¶
工具支持导出和导入，导出的文件后缀为 .tool。
点击【导入创建】，选择后缀名为 .tool 的文件并打开。
工具将自动导入，导入的工具默认状态为【已禁用】，可以点击工具，进入编辑工具查看和修改工具。
6 复制工具¶
点击工具面板的【复制】按钮，打开复制工具对话框，对原工具内容进行编辑修改后点击【创建】即可快速创建一个新工具。
7 删除工具¶
点击工具面板的【删除】按钮，即可对工具进行删除。
注意： 工具删除后，不可恢复。 如果应用引用了该工具，在编排页面将显示【该工具不可用】的提示信息。
