Skip to main content
Build custom middleware by implementing hooks that run at specific points in the agent execution flow.

Hooks

Middleware provides two styles of hooks to intercept agent execution:

Node-style hooks

Run sequentially at specific execution points.

Wrap-style hooks

Run around each model or tool call.

Node-style hooks

Run sequentially at specific execution points. Use for logging, validation, and state updates. Choose the hooks your middleware needs. You can choose between node-style hooks and wrap-style hooks. Node-style hooks run at specific execution points: Wrap-style hooks run around each call, giving you control over execution: Example:

Wrap-style hooks

Intercept execution and control when the handler is called. Use for retries, caching, and transformation. You decide if the handler is called zero times (short-circuit), once (normal flow), or multiple times (retry logic). Available hooks:
  • wrapModelCall - Around each model call
  • wrapToolCall - Around each tool call
Example:

State updates

Both node-style and wrap-style hooks can update agent state. The mechanism differs:
  • Node-style hooks (beforeAgent, beforeModel, afterModel, afterAgent): Return a dict directly. The dict is applied to the agent state using the graph’s reducers.
  • Wrap-style hooks (wrapModelCall, wrapToolCall): For model calls, return a Command directly to inject state updates alongside the model response. For tool calls, return a Command directly. Use these when you need to track or update state based on logic that runs during the model or tool call, such as summarization trigger points, usage metadata, or custom fields calculated from the request or response.

Node-style hooks

Return a dict from a node-style hook to merge updates into agent state. The dict keys map to state fields.

Wrap-style hooks

Return a Command directly from wrapModelCall to inject state updates from the model call layer:
The Command flows through the graph’s reducers, so updates are applied correctly and messages are additive rather than replacing existing state.

Composition with multiple middleware

When multiple middleware layers return responses, the framework passes on the last AIMessages produced:
  • AIMessage flows through: Each middleware’s handler() receives the AIMessage from the previous layer. When a middleware returns an AIMessage, that becomes the input to the next middleware’s handler.
  • Command without message updates is pass-through: If a middleware returns a Command whose state update does not touch messages, the framework treats it as a no-op for message flow. The next middleware’s handler receives the AIMessage from the middleware before the one that returned the Command.
  • Reducer behavior and retry-safety: Commands still apply through reducers (messages additive, outer wins on conflicts). Retry logic discards commands from earlier calls.

Create middleware

python An AgentMiddleware subclass can declare three class attributes that the agent factory picks up at compile time:
  • state_schema — extend the agent state with custom fields. See Custom state schema.
  • tools — register additional tools that ship with the middleware (e.g., write_todos on the to-do list middleware).
  • transformers — register scope-aware stream transformer factories. See Custom stream transformers. :::
createMiddleware accepts three configuration fields that the agent factory picks up at compile time:
  • stateSchema — extend the agent state with custom fields. See Custom state schema.
  • tools — register additional tools that ship with the middleware.
  • streamTransformers — register scope-aware stream transformer factories. See Custom stream transformers.
Example:
When to use classes:
  • Defining both sync and async implementations for the same hook
  • Multiple hooks needed in a single middleware
  • Complex configuration required (e.g., configurable thresholds, custom models)
  • Reuse across projects with init-time configuration
::: Use the createMiddleware function to define custom middleware:

Custom state schema

If your middleware needs to track state across hooks, middleware can extend the agent’s state with custom properties. This enables middleware to:
  • Track state across execution: Maintain counters, flags, or other values that persist throughout the agent’s execution lifecycle
  • Share data between hooks: Pass information from beforeModel to afterModel or between different middleware instances
  • Implement cross-cutting concerns: Add functionality like rate limiting, usage tracking, user context, or audit logging without modifying the core agent logic
  • Make conditional decisions: Use accumulated state to determine whether to continue execution, jump to different nodes, or modify behavior dynamically
State fields can be either public or private. Fields that start with an underscore (_) are considered private and will not be included in the agent’s result. Only public fields (those without a leading underscore) are returned. This is useful for storing internal middleware state that shouldn’t be exposed to the caller, such as temporary tracking variables or internal flags:

Custom stream transformers

Middleware-registered transformers require langchain@1.4.3 or later.
Middleware can register stream transformer factories that project events from the live agent stream onto typed extension channels. This is useful for surfacing counters, side-channel artifacts, partial outputs, or wire-level redaction without coupling to the framework’s built-in projections. At compile time, middleware-registered factories merge with anything the caller passes directly to the agent factory. The final ordering rules keep the built-in ToolCallTransformer in front and let caller-supplied entries land last. Pass streamTransformers to createMiddleware as a tuple of factories. Each factory has the shape () => StreamTransformer<any> (zero arguments) and is invoked once per scope; returning a fresh transformer per call keeps each subgraph isolated.
See Register transformers on middleware for the full ordering rules and the PII redaction example.

Custom context

Middleware can define a custom context schema to access per-invocation metadata. Unlike state, context is read-only and not persisted between invocations. This makes it ideal for:
  • User information: Pass user ID, roles, or preferences that don’t change during execution
  • Configuration overrides: Provide per-invocation settings like rate limits or feature flags
  • Tenant/workspace context: Include organization-specific data for multi-tenant applications
  • Request metadata: Pass request IDs, API keys, or other metadata needed by middleware
Define a context schema using Zod and access it via runtime.context in middleware hooks. Required fields in the context schema will be enforced at the TypeScript level, ensuring you must provide them when calling agent.invoke().
Required context fields: When you define required fields in your contextSchema (fields without .optional() or .default()), TypeScript will enforce that these fields must be provided during agent.invoke() calls. This ensures type safety and prevents runtime errors from missing required context.

Execution order

When using multiple middleware, understand how they execute:
Before hooks run in order:
  1. middleware1.before_agent()
  2. middleware2.before_agent()
  3. middleware3.before_agent()
Agent loop starts
  1. middleware1.before_model()
  2. middleware2.before_model()
  3. middleware3.before_model()
Wrap hooks nest like function calls:
  1. middleware1.wrap_model_call()middleware2.wrap_model_call()middleware3.wrap_model_call() → model
After hooks run in reverse order:
  1. middleware3.after_model()
  2. middleware2.after_model()
  3. middleware1.after_model()
Agent loop ends
  1. middleware3.after_agent()
  2. middleware2.after_agent()
  3. middleware1.after_agent()
Key rules:
  • before_* hooks: First to last
  • after_* hooks: Last to first (reverse)
  • wrap_* hooks: Nested (first middleware wraps all others)

Agent jumps

To exit early from middleware, return a dictionary with jump_to: Available jump targets:
  • 'end': Jump to the end of the agent execution (or the first after_agent hook)
  • 'tools': Jump to the tools node
  • 'model': Jump to the model node (or the first before_model hook)

Best practices

  1. Keep middleware focused - each should do one thing well
  2. Handle errors gracefully - don’t let middleware errors crash the agent
  3. Use appropriate hook types:
    • Node-style for sequential logic (logging, validation)
    • Wrap-style for control flow (retry, fallback, caching)
  4. Clearly document any custom state properties
  5. Unit test middleware independently before integrating
  6. Consider execution order - place critical middleware first in the list
  7. Use built-in middleware when possible

Examples

Dynamic prompt

Dynamically modify the system prompt at runtime to inject context, user-specific instructions, or other information before each model call. This is one of the most common middleware use cases. Use the systemMessage field in ModelRequest to read and modify the system prompt. It contains a SystemMessage object (even if the agent was created with a string systemPrompt).
Use SystemMessage.concat to preserve cache control metadata or structured content blocks created by other middleware.

Dynamic model selection

Dynamically selecting tools

Select relevant tools at runtime to improve performance and accuracy. This section covers filtering pre-registered tools. For registering tools that are discovered at runtime (e.g., from MCP servers), see Runtime tool registration. Benefits:
  • Shorter prompts - Reduce complexity by exposing only relevant tools
  • Better accuracy - Models choose correctly from fewer options
  • Permission control - Dynamically filter tools based on user access

Tool call monitoring

Prompt caching (Anthropic)

When working with Anthropic models, use structured content blocks with cache control directives to cache large system prompts:
Notes:
  • ModelRequest.system_message is always a SystemMessage object, even if the agent was created with system_prompt="string"
  • Use SystemMessage.content_blocks to access content as a list of blocks, regardless of whether the original content was a string or list
  • When modifying system messages, use content_blocks and append new blocks to preserve existing structure
  • You can pass SystemMessage objects directly to create_agent’s system_prompt parameter for advanced use cases like cache control
::: Modify system messages in middleware using the systemMessage field in ModelRequest. It contains a SystemMessage object (even if the agent was created with a string systemPrompt). Example: Chaining middleware - Different middleware can use different approaches:
The resulting system message will be:
Use SystemMessage.concat to preserve cache control metadata or structured content blocks created by other middleware.

Additional resources