273 lines
11 KiB
Markdown
273 lines
11 KiB
Markdown
# 智能体
|
||
|
||
## 智能体开发
|
||
|
||
系统基于 [LangGraph](https://github.com/langchain-ai/langgraph) 并通过统一的 `AgentManager` 管理所有智能体。`src/agents/__init__.py` 会在启动时遍历 `src/agents` 目录，对每个包含 `__init__.py` 的子包执行自动发现：所有继承 `BaseAgent` 的类都会被注册并立即初始化，因此只要代码落位正确，就不需要再手动登记或修改管理器。
|
||
|
||
仓库预置了若干可直接运行的智能体：`chatbot` 聚焦对话与动态工具调度，`reporter` 演示报告类链路。这些目录展示了上下文类、Graph 构造方式、子智能体引用以及中间件组合的范例，新增功能时可以直接复用。
|
||
|
||
### 智能体元数据配置
|
||
|
||
每个智能体可以通过在智能体目录下创建 `metadata.toml` 文件来配置元数据信息。这个文件使用 TOML 格式，包含以下字段：
|
||
|
||
- `name`: 智能体显示名称
|
||
- `description`: 智能体功能描述
|
||
- `examples`: 示例问题列表（数组格式）
|
||
|
||
例如，`src/agents/chatbot/metadata.toml`：
|
||
|
||
<<< @/../src/agents/chatbot/metadata.toml
|
||
|
||
**注意**：`metadata.toml` 文件是可选的，如果没有提供，系统将使用智能体类的基本属性。
|
||
|
||
### 创建新的智能体
|
||
|
||
在 `src/agents` 下新建一个包，保持与现有目录一致的结构：放置 Graph 构造逻辑（通常命名为 `graph.py`），并在包内的 `__init__.py` 中暴露主类。
|
||
|
||
智能体类必须继承 `src.agents.common.BaseAgent`，同时实现异步的 `get_graph` 方法来返回编译后的 LangGraph 实例，并配置好 `checkpointer`，否则无法从历史对话中恢复。
|
||
|
||
需要额外上下文字段时，可继承 `BaseContext` 构建自己的配置表单，再把类绑定到 `context_schema`，平台会在 `saves/agents/<module>` 下生成默认配置。
|
||
|
||
案例 基于MySQL工具，以及自定义 MCP Server 的数据库报表助手。
|
||
|
||
<<< @/../src/agents/reporter/graph.py
|
||
|
||
|
||
|
||
智能体实例的生命周期交给管理器处理，会在自动发现时完成初始化并缓存单例，以便快速响应请求。在容器内热重载时，只要保存文件即可触发重新导入；需要强制刷新可调用 `agent_manager.get_agent(<id>, reload=True)`。
|
||
|
||
更多动态工具选择与 MCP 注册的例子，见 `src/agents/chatbot/graph.py` 中的中间件组合。
|
||
|
||
### 拓展现有智能体
|
||
|
||
智能体保持为 LangGraph 的标准节点组合，因此可以在原有 `graph.py` 中添加节点、条件与消息转换器。复用现成上下文时，只需扩展当前 `context_schema` 的字段；若功能差异较大，可以创建新的上下文类并替换 `context_schema`。
|
||
|
||
对工具、模型或提示语的调整建议封装到中间件或独立函数里，既方便多智能体共用，又能保持 `BaseAgent` 的基础接口稳定。变更提交后无需手动刷新注册表，只要确保包结构未改变，智能体会在热重载中自动更新。
|
||
|
||
### 子智能体与中间件
|
||
|
||
子智能体集中放在 `src/agents/common/subagents` 目录，典型例子是 `calc_agent`，它通过 LangChain 的 `create_agent` 构建计算器能力并以工具暴露给主图。新增子智能体时沿用这一结构：在目录内编写封装函数与 `@tool` 装饰器，导出后即可被任意智能体调用。
|
||
|
||
中间件位于 `src/agents/common/middlewares`，包含上下文感知提示词、模型选择、动态工具加载以及附件注入等实现。如果需要编写新的中间件，请遵循 LangChain 官方文档中对 `AgentMiddleware`、`ModelRequest`、`ModelResponse` 等接口的定义，完成后在该目录的 `__init__.py` 暴露入口，主智能体即可在 `middleware` 列表中引用。
|
||
|
||
#### 文件上传中间件
|
||
|
||
文件上传功能通过 `inject_attachment_context` 中间件实现（位于 `src/agents/common/middlewares/attachment_middleware.py`）。该中间件基于 LangChain 1.0 的 `AgentMiddleware` 标准实现，具有以下特点：
|
||
|
||
1. **状态扩展**：定义 `AttachmentState` 扩展 `AgentState`，添加可选的 `attachments` 字段
|
||
2. **自动注入**：在模型调用前，从 `request.state` 中读取附件并转换为 `SystemMessage`
|
||
3. **向后兼容**：不使用文件上传的智能体不受影响
|
||
|
||
##### 为智能体启用文件上传
|
||
|
||
只需两步：
|
||
|
||
**步骤 1：声明能力**（让前端显示上传按钮）
|
||
|
||
```python
|
||
class MyAgent(BaseAgent):
|
||
capabilities = ["file_upload"]
|
||
```
|
||
|
||
**步骤 2：添加中间件**（让智能体能够处理附件内容）
|
||
|
||
```python
|
||
from src.agents.common.middlewares import inject_attachment_context
|
||
|
||
async def get_graph(self):
|
||
graph = create_agent(
|
||
model=load_chat_model("..."),
|
||
tools=get_tools(),
|
||
middleware=[
|
||
inject_attachment_context, # 添加附件中间件
|
||
context_aware_prompt, # 其他中间件...
|
||
# ...
|
||
],
|
||
checkpointer=await self._get_checkpointer(),
|
||
)
|
||
return graph
|
||
```
|
||
|
||
##### 工作流程
|
||
|
||
1. **前端上传**：用户在聊天界面上传文档（txt、md、docx、html）
|
||
2. **API 解析**：后端将文档转换为 Markdown 格式并存储到数据库（超过 32k 会被截断）
|
||
3. **自动加载**：API 层在调用 agent 前从数据库加载附件数据
|
||
4. **中间件注入**：`inject_attachment_context` 自动将附件内容注入为系统消息
|
||
5. **模型处理**：LLM 接收到附件内容和用户问题，进行综合回答
|
||
|
||
这种设计确保了附件功能的可选性和可扩展性，任何智能体都可以通过添加中间件快速启用文件上传能力。
|
||
|
||
## 内置工具与 MCP 集成
|
||
|
||
系统会根据配置自动组装工具集合，涵盖知识图谱查询、向量检索生成的动态工具、MySQL 只读查询能力、Tavily 搜索以及所有注册的 MCP 工具。
|
||
|
||
工具的启用状态和描述由配置文件或环境变量决定，当依赖缺失时会被中间件自动忽略，从而避免在图中加载不可用能力。MCP Server 的接入方式保持不变，只需在 `src/agents/common/mcp.py` 的 `MCP_SERVERS` 中填入服务地址与 `transport` 类型，如需更多范式可参阅 LangChain 官方文档。
|
||
|
||
### MCP 服务器配置方式
|
||
|
||
系统支持四种 MCP 服务器配置方式，可根据具体场景选择：
|
||
|
||
#### 1. 远程 HTTP 服务器
|
||
|
||
```python
|
||
MCP_SERVERS = {
|
||
"sequentialthinking": {
|
||
"url": "https://remote.mcpservers.org/sequentialthinking/mcp",
|
||
"transport": "streamable_http",
|
||
}
|
||
}
|
||
```
|
||
|
||
**特点**：
|
||
- 通过 HTTP 远程访问，无需本地安装，适合公开可用的 MCP 服务
|
||
- 启动速度快，无需本地依赖
|
||
|
||
#### 2. 使用 npx 运行 Node.js 包
|
||
|
||
```python
|
||
MCP_SERVERS = {
|
||
"mcp-server-chart": {
|
||
"command": "npx",
|
||
"args": ["-y", "@antv/mcp-server-chart"],
|
||
"transport": "stdio"
|
||
},
|
||
}
|
||
```
|
||
|
||
**特点**：
|
||
- 使用 npx 直接运行 Node.js 包，`-y` 参数自动下载并运行指定包
|
||
- 适合 Node.js 生态的 MCP 服务，需要确保 npx 可以使用
|
||
|
||
#### 3. 使用 uvx 运行 Python 包
|
||
|
||
```python
|
||
MCP_SERVERS = {
|
||
"mysql-mcp-server": {
|
||
"command": "uvx",
|
||
"args": ["mysql_mcp_server"],
|
||
"env": {
|
||
"MYSQL_DATABASE": "your_database",
|
||
"MYSQL_HOST": "localhost",
|
||
"MYSQL_PASSWORD": "your_password",
|
||
"MYSQL_PORT": "3306",
|
||
"MYSQL_USER": "your_username"
|
||
},
|
||
"transport": "stdio"
|
||
}
|
||
}
|
||
```
|
||
|
||
**特点**：
|
||
- 使用 uvx 运行已发布的 Python 包，自动管理虚拟环境和依赖
|
||
- 适合 PyPI 上已发布的 MCP 服务
|
||
|
||
#### 4. 使用 uv 运行本地仓库
|
||
|
||
```python
|
||
MCP_SERVERS = {
|
||
"arxiv-mcp-server": {
|
||
"command": "uv",
|
||
"args": [
|
||
"tool",
|
||
"run",
|
||
"arxiv-mcp-server",
|
||
"--storage-path", "src/agents/mcp_repos/arxiv-mcp-server"
|
||
],
|
||
"transport": "stdio"
|
||
}
|
||
}
|
||
```
|
||
|
||
**特点**：
|
||
- 直接运行本地 git 仓库中的 MCP 服务
|
||
- 加载速度快，支持热重载，适合开发调试和自定义 MCP 服务
|
||
- 需要先 git clone 对应仓库到指定路径
|
||
|
||
### 配置参数说明
|
||
|
||
- `url`: 远程 HTTP 服务器的 URL（仅 streamable_http 传输）
|
||
- `command`: 启动 MCP 服务的命令
|
||
- `args`: 启动参数列表
|
||
- `env`: 环境变量配置，用于数据库连接等敏感信息
|
||
- `transport`: 传输协议，支持 `stdio`（本地）和 `streamable_http`（远程）
|
||
|
||
### 动态工具加载
|
||
|
||
系统支持动态加载 MCP 工具：
|
||
|
||
```python
|
||
from src.agents.common.mcp import get_mcp_tools, add_mcp_server
|
||
|
||
# 获取特定服务器的工具
|
||
tools = await get_mcp_tools("sequentialthinking")
|
||
|
||
# 动态添加新的 MCP 服务器
|
||
add_mcp_server("custom-server", {
|
||
"url": "https://your-mcp-server.com/mcp",
|
||
"transport": "streamable_http"
|
||
})
|
||
|
||
# 获取所有 MCP 工具
|
||
all_tools = await get_all_mcp_tools()
|
||
```
|
||
### MySQL 数据库
|
||
|
||
在 数据库报表助手（SqlReporterAgent） 中，可以通过配置下面环境变量，让 Agent 能够连接到 MySQL 数据库。并通过执行 SQL 查询，获取数据库中的数据。
|
||
|
||
设置数据库连接时，在 `.env` 中提供以下字段：
|
||
|
||
```env
|
||
MYSQL_HOST=192.168.1.100
|
||
MYSQL_USER=username
|
||
MYSQL_PASSWORD=your_secure_password
|
||
MYSQL_DATABASE=database_name
|
||
MYSQL_DATABASE_DESCRIPTION=业务主库（可选提示）
|
||
MYSQL_PORT=3306
|
||
MYSQL_CHARSET=utf8mb4
|
||
```
|
||
|
||
所有查询限定在只读范围（SELECT、SHOW、DESCRIBE、EXPLAIN），请求会经过表名校验与超时控制，默认限制 60 秒与 100 行输出，并可通过配置调整上限。连接信息会反馈给 LangGraph，智能体可以自动陈述数据库用途并选择更准确的检索策略。详见代码部分 `src/agents/common/toolkits/mysql/`
|
||
|
||
### 多模态图片支持
|
||
|
||
系统支持接收图片作为输入，与文本结合形成多模态查询。图片支持的核心特性如下：
|
||
|
||
#### 1. 图片上传与处理
|
||
- 通过 `/chat/image/upload` 接口上传图片
|
||
- 自动处理图片格式转换和压缩
|
||
- 返回 base64 编码的图片数据
|
||
- 图片大小限制为 10MB
|
||
- 支持的图片格式：JPEG、PNG、WebP、GIF、BMP
|
||
- 自动压缩超过 5MB 的图片
|
||
|
||
当发送包含图片的请求时，消息格式为：
|
||
```json
|
||
{
|
||
"query": "这张图片里有什么？",
|
||
"image_content": "<base64编码的图片数据>",
|
||
"config": {},
|
||
"meta": {}
|
||
}
|
||
```
|
||
|
||
智能体会自动识别多模态消息并将其传递给支持图片的模型。如果模型不支持图片，会自动忽略图片内容，只处理文本部分。系统会将图片转换为符合模型要求的格式（通常是 base64 编码的 JPEG 或 PNG），确保与主流多模态模型兼容。
|
||
|
||
目前仅支持上传单个图片，图片以 base64 编码形式存储在数据库。系统会自动处理图片的格式转换和压缩，并生成缩略图以优化性能。
|
||
|
||
### 图片上传响应格式
|
||
|
||
```json
|
||
{
|
||
"success": true,
|
||
"image_content": "<base64编码的原始图片数据>",
|
||
"thumbnail_content": "<base64编码的缩略图数据>",
|
||
"width": 1024,
|
||
"height": 768,
|
||
"format": "JPEG",
|
||
"mime_type": "image/jpeg"
|
||
}
|
||
```
|
||
|
||
系统会将图片信息与用户查询一同传递给支持多模态的模型，并自动适配模型要求的格式。
|