钩子
中间件提供两种样式的钩子来拦截代理执行:节点式钩子
在特定执行点顺序运行。
包装式钩子
在每个模型或工具调用周围运行。
节点式钩子
在特定执行点顺序运行。用于日志记录、验证和状态更新。 选择中间件所需的钩子。您可以在节点式钩子和包装式钩子之间选择。 节点式钩子在特定执行点运行:| 钩子 | 运行时机 |
|---|---|
beforeAgent | 代理开始之前(每次调用一次) |
beforeModel | 每次模型调用之前 |
afterModel | 每次模型响应之后 |
afterAgent | 代理完成之后(每次调用一次) |
| 钩子 | 运行时机 |
|---|---|
wrapModelCall | 每次模型调用周围 |
wrapToolCall | 每次工具调用周围 |
包装式钩子
拦截执行并控制处理程序的调用时机。用于重试、缓存和转换。 您决定处理程序是调用零次(短路)、一次(正常流程)还是多次(重试逻辑)。 可用钩子:wrapModelCall- 每次模型调用周围wrapToolCall- 每次工具调用周围
状态更新
节点式和包装式钩子都可以更新代理状态。机制不同:- 节点式钩子(
beforeAgent、beforeModel、afterModel、afterAgent):直接返回字典。该字典使用图的归约器应用到代理状态。 - 包装式钩子(
wrapModelCall、wrapToolCall):对于模型调用,直接返回Command以在模型响应旁边注入状态更新。对于工具调用,直接返回Command。当您需要基于在模型或工具调用期间运行的逻辑(例如摘要触发点、使用元数据或从请求或响应计算的自定义字段)跟踪或更新状态时,使用这些钩子。
节点式钩子
从节点式钩子返回字典以将更新合并到代理状态。字典键映射到状态字段。包装式钩子
从wrapModelCall 直接返回 Command 以从模型调用层注入状态更新:
Command 通过图的归约器流动,因此更新被正确应用,并且消息是附加的,而不是替换现有状态。
与多个中间件组合
当多个中间件层返回响应时,框架传递最后生成的AIMessage:
- AIMessage 流动: 每个中间件的
handler()接收来自上一层的AIMessage。当中间件返回AIMessage时,它成为下一个中间件处理程序的输入。 - 没有消息更新的 Command 透传: 如果中间件返回的
Command的状态更新不涉及messages,框架将其视为消息流的无操作。下一个中间件的处理程序接收来自返回 Command 的中间件之前的中间件的AIMessage。 - 归约器行为和重试安全性: 命令仍然通过归约器应用(消息附加,外部在冲突时获胜)。重试逻辑会丢弃来自先前调用的命令。
创建中间件
使用createMiddleware 函数定义自定义中间件:
自定义状态模式
如果您的中间件需要跨钩子跟踪状态,中间件可以用自定义属性扩展代理的状态。这使中间件能够:- 跨执行跟踪状态:维护计数器、标志或其他在代理执行生命周期中持续存在的值
- 在钩子之间共享数据:将信息从
beforeModel传递到afterModel或在不同中间件实例之间传递 - 实现横切关注点:添加功能,如速率限制、使用跟踪、用户上下文或审计日志,而无需修改核心代理逻辑
- 做出条件决策:使用累积状态来确定是否继续执行、跳转到不同节点或动态修改行为
_) 开头的字段被视为私有,不会包含在代理的结果中。只有公共字段(没有前导 underscore)才会返回。
这对于存储不应暴露给调用者的内部中间件状态非常有用,例如临时跟踪变量或内部标志:
自定义上下文
中间件可以定义自定义上下文模式以访问每次调用的元数据。与状态不同,上下文是只读的,并且不会在调用之间持久化。这使其非常适合:- 用户信息:传递用户 ID、角色或在执行期间不会更改的偏好
- 配置覆盖:提供每次调用的设置,如速率限制或功能标志
- 租户/工作区上下文:为多租户应用程序包含组织特定数据
- 请求元数据:传递请求 ID、API 密钥或中间件所需的其他元数据
runtime.context 访问它。上下文模式中的必填字段将在 TypeScript 级别强制执行,确保在调用 agent.invoke() 时必须提供它们。
contextSchema 中定义必填字段(没有 .optional() 或 .default() 的字段)时,TypeScript 将强制在 agent.invoke() 调用期间必须提供这些字段。这确保了类型安全并防止因缺少必填上下文而导致的运行时错误。
执行顺序
当使用多个中间件时,了解它们如何执行:执行流程
执行流程
前置钩子按顺序运行:
middleware1.before_agent()middleware2.before_agent()middleware3.before_agent()
middleware1.before_model()middleware2.before_model()middleware3.before_model()
middleware1.wrap_model_call()→middleware2.wrap_model_call()→middleware3.wrap_model_call()→ model
middleware3.after_model()middleware2.after_model()middleware1.after_model()
middleware3.after_agent()middleware2.after_agent()middleware1.after_agent()
before_*钩子:从第一个到最后一个after_*钩子:从最后一个到第一个(相反)wrap_*钩子:嵌套(第一个中间件包装所有其他中间件)
代理跳转
要从中间件提前退出,返回一个带有jump_to 的字典:
可用跳转目标:
'end':跳转到代理执行的末尾(或第一个after_agent钩子)'tools':跳转到工具节点'model':跳转到模型节点(或第一个before_model钩子)
最佳实践
- 保持中间件专注 - 每个中间件应做好一件事
- 优雅地处理错误 - 不要让中间件错误导致代理崩溃
- 使用适当的钩子类型:
- 节点式用于顺序逻辑(日志记录、验证)
- 包装式用于控制流(重试、回退、缓存)
- 清晰记录任何自定义状态属性
- 在集成之前独立对中间件进行单元测试
- 考虑执行顺序 - 将关键中间件放在列表的前面
- 尽可能使用内置中间件
示例
动态提示
在运行时动态修改系统提示以注入上下文、用户特定指令或其他信息,然后再进行每次模型调用。这是最常见的中间件用例之一。 使用ModelRequest 中的 systemMessage 字段读取和修改系统提示。它包含一个 SystemMessage 对象(即使代理是使用字符串 systemPrompt 创建的)。
SystemMessage.concat 来保留缓存控制元数据或由其他中间件创建的结构化内容块。
动态模型选择
动态选择工具
在运行时选择相关工具以提高性能和准确性。本节介绍过滤预注册工具。有关注册在运行时发现的工具(例如,从 MCP 服务器),请参见运行时工具注册。 好处:- 更短的提示 - 通过仅暴露相关工具来降低复杂性
- 更好的准确性 - 模型从更少的选项中正确选择
- 权限控制 - 基于用户访问动态过滤工具
工具调用监控
提示缓存(Anthropic)
当使用 Anthropic 模型时,使用带有缓存控制指令的结构化内容块来缓存大型系统提示:- 装饰器
- 类
ModelRequest.system_message始终是一个SystemMessage对象,即使代理是使用system_prompt="string"创建的- 使用
SystemMessage.content_blocks以块列表的形式访问内容,无论原始内容是字符串还是列表 - 修改系统消息时,使用
content_blocks并附加新块以保留现有结构 - 您可以直接将
SystemMessage对象传递给create_agent的system_prompt参数,用于高级用例,如缓存控制
ModelRequest 中的 systemMessage 字段修改系统消息。它包含一个 SystemMessage 对象(即使代理是使用字符串 systemPrompt 创建的)。
示例:链式中间件 - 不同的中间件可以使用不同的方法:
SystemMessage.concat 来保留缓存控制元数据或由其他中间件创建的结构化内容块。
其他资源
连接这些文档 到 Claude、VSCode 等,通过 MCP 获取实时答案。

