Agents¶
Classes:
Name | Description |
---|---|
AgentState |
The state of the agent. |
Functions:
Name | Description |
---|---|
create_react_agent |
Creates an agent graph that calls tools in a loop until a stopping condition is met. |
AgentState
¶
Bases: TypedDict
The state of the agent.
create_react_agent
¶
create_react_agent(
model: Union[str, LanguageModelLike],
tools: Union[
Sequence[Union[BaseTool, Callable, dict[str, Any]]],
ToolNode,
],
*,
prompt: Optional[Prompt] = None,
response_format: Optional[
Union[
StructuredResponseSchema,
tuple[str, StructuredResponseSchema],
]
] = None,
pre_model_hook: Optional[RunnableLike] = None,
post_model_hook: Optional[RunnableLike] = None,
state_schema: Optional[StateSchemaType] = None,
config_schema: Optional[Type[Any]] = None,
checkpointer: Optional[Checkpointer] = None,
store: Optional[BaseStore] = None,
interrupt_before: Optional[list[str]] = None,
interrupt_after: Optional[list[str]] = None,
debug: bool = False,
version: Literal["v1", "v2"] = "v2",
name: Optional[str] = None
) -> CompiledStateGraph
Creates an agent graph that calls tools in a loop until a stopping condition is met.
For more details on using create_react_agent
, visit Agents documentation.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
model
|
Union[str, LanguageModelLike]
|
The |
required |
tools
|
Union[Sequence[Union[BaseTool, Callable, dict[str, Any]]], ToolNode]
|
A list of tools or a ToolNode instance. If an empty list is provided, the agent will consist of a single LLM node without tool calling. |
required |
prompt
|
Optional[Prompt]
|
An optional prompt for the LLM. Can take a few different forms:
|
None
|
response_format
|
Optional[Union[StructuredResponseSchema, tuple[str, StructuredResponseSchema]]]
|
An optional schema for the final agent output. If provided, output will be formatted to match the given schema and returned in the 'structured_response' state key.
If not provided,
Important
Note The graph will make a separate call to the LLM to generate the structured response after the agent loop is finished. This is not the only strategy to get structured responses, see more options in this guide. |
None
|
pre_model_hook
|
Optional[RunnableLike]
|
An optional node to add before the
Important At least one of |
None
|
post_model_hook
|
Optional[RunnableLike]
|
An optional node to add after the Note Only available with |
None
|
state_schema
|
Optional[StateSchemaType]
|
An optional state schema that defines graph state.
Must have |
None
|
config_schema
|
Optional[Type[Any]]
|
An optional schema for configuration. Use this to expose configurable parameters via agent.config_specs. |
None
|
checkpointer
|
Optional[Checkpointer]
|
An optional checkpoint saver object. This is used for persisting the state of the graph (e.g., as chat memory) for a single thread (e.g., a single conversation). |
None
|
store
|
Optional[BaseStore]
|
An optional store object. This is used for persisting data across multiple threads (e.g., multiple conversations / users). |
None
|
interrupt_before
|
Optional[list[str]]
|
An optional list of node names to interrupt before. Should be one of the following: "agent", "tools". This is useful if you want to add a user confirmation or other interrupt before taking an action. |
None
|
interrupt_after
|
Optional[list[str]]
|
An optional list of node names to interrupt after. Should be one of the following: "agent", "tools". This is useful if you want to return directly or run additional processing on an output. |
None
|
debug
|
bool
|
A flag indicating whether to enable debug mode. |
False
|
version
|
Literal['v1', 'v2']
|
Determines the version of the graph to create. Can be one of:
|
'v2'
|
name
|
Optional[str]
|
An optional name for the CompiledStateGraph. This name will be automatically used when adding ReAct agent graph to another graph as a subgraph node - particularly useful for building multi-agent systems. |
None
|
Returns:
Type | Description |
---|---|
CompiledStateGraph
|
A compiled LangChain runnable that can be used for chat interactions. |
The "agent" node calls the language model with the messages list (after applying the prompt).
If the resulting AIMessage contains tool_calls
, the graph will then call the "tools".
The "tools" node executes the tools (1 tool per tool_call
) and adds the responses to the messages list
as ToolMessage
objects. The agent node then calls the language model again.
The process repeats until no more tool_calls
are present in the response.
The agent then returns the full list of messages as a dictionary containing the key "messages".
sequenceDiagram
participant U as User
participant A as LLM
participant T as Tools
U->>A: Initial input
Note over A: Prompt + LLM
loop while tool_calls present
A->>T: Execute tools
T-->>A: ToolMessage for each tool_calls
end
A->>U: Return final state
Example
from langgraph.prebuilt import create_react_agent
def check_weather(location: str) -> str:
'''Return the weather forecast for the specified location.'''
return f"It's always sunny in {location}"
graph = create_react_agent(
"anthropic:claude-3-7-sonnet-latest",
tools=[check_weather],
prompt="You are a helpful assistant",
)
inputs = {"messages": [{"role": "user", "content": "what is the weather in sf"}]}
for chunk in graph.stream(inputs, stream_mode="updates"):
print(chunk)
ToolNode
¶
Bases: RunnableCallable
A node that runs the tools called in the last AIMessage.
It can be used either in StateGraph with a "messages" state key (or a custom key passed via ToolNode's 'messages_key'). If multiple tool calls are requested, they will be run in parallel. The output will be a list of ToolMessages, one for each tool call.
Tool calls can also be passed directly as a list of ToolCall
dicts.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
tools
|
Sequence[Union[BaseTool, Callable]]
|
A sequence of tools that can be invoked by this node. Tools can be BaseTool instances or plain functions that will be converted to tools. |
required |
name
|
str
|
The name identifier for this node in the graph. Used for debugging and visualization. Defaults to "tools". |
'tools'
|
tags
|
Optional[list[str]]
|
Optional metadata tags to associate with the node for filtering and organization. Defaults to None. |
None
|
handle_tool_errors
|
Union[bool, str, Callable[..., str], tuple[type[Exception], ...]]
|
Configuration for error handling during tool execution. Defaults to True. Supports multiple strategies:
|
True
|
messages_key
|
str
|
The key in the state dictionary that contains the message list. This same key will be used for the output ToolMessages. Defaults to "messages". |
'messages'
|
Example
Basic usage with simple tools:
from langgraph.prebuilt import ToolNode
from langchain_core.tools import tool
@tool
def calculator(a: int, b: int) -> int:
"""Add two numbers."""
return a + b
tool_node = ToolNode([calculator])
Custom error handling:
def handle_math_errors(e: ZeroDivisionError) -> str:
return "Cannot divide by zero!"
tool_node = ToolNode([calculator], handle_tool_errors=handle_math_errors)
Direct tool call execution:
Note
The ToolNode expects input in one of three formats: 1. A dictionary with a messages key containing a list of messages 2. A list of messages directly 3. A list of tool call dictionaries
When using message formats, the last message must be an AIMessage with tool_calls populated. The node automatically extracts and processes these tool calls concurrently.
For advanced use cases involving state injection or store access, tools can be annotated with InjectedState or InjectedStore to receive graph context automatically.
Methods:
Name | Description |
---|---|
inject_tool_args |
Inject graph state and store into tool call arguments. |
inject_tool_args
¶
inject_tool_args(
tool_call: ToolCall,
input: Union[
list[AnyMessage], dict[str, Any], BaseModel
],
store: Optional[BaseStore],
) -> ToolCall
Inject graph state and store into tool call arguments.
This method enables tools to access graph context that should not be controlled by the model. Tools can declare dependencies on graph state or persistent storage using InjectedState and InjectedStore annotations. This method automatically identifies these dependencies and injects the appropriate values.
The injection process preserves the original tool call structure while adding the necessary context arguments. This allows tools to be both model-callable and context-aware without exposing internal state management to the model.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
tool_call
|
ToolCall
|
The tool call dictionary to augment with injected arguments. Must contain 'name', 'args', 'id', and 'type' fields. |
required |
input
|
Union[list[AnyMessage], dict[str, Any], BaseModel]
|
The current graph state to inject into tools requiring state access. Can be a message list, state dictionary, or BaseModel instance. |
required |
store
|
Optional[BaseStore]
|
The persistent store instance to inject into tools requiring storage. Will be None if no store is configured for the graph. |
required |
Returns:
Type | Description |
---|---|
ToolCall
|
A new ToolCall dictionary with the same structure as the input but with |
ToolCall
|
additional arguments injected based on the tool's annotation requirements. |
Raises:
Type | Description |
---|---|
ValueError
|
If a tool requires store injection but no store is provided, or if state injection requirements cannot be satisfied. |
Note
This method is automatically called during tool execution but can also be used manually when working with the Send API or custom routing logic. The injection is performed on a copy of the tool call to avoid mutating the original.
Tool execution node for LangGraph workflows.
This module provides prebuilt functionality for executing tools in LangGraph.
Tools are functions that models can call to interact with external systems, APIs, databases, or perform computations.
The module implements several key design patterns: - Parallel execution of multiple tool calls for efficiency - Robust error handling with customizable error messages - State injection for tools that need access to graph state - Store injection for tools that need persistent storage - Command-based state updates for advanced control flow
Key Components
ToolNode: Main class for executing tools in LangGraph workflows InjectedState: Annotation for injecting graph state into tools InjectedStore: Annotation for injecting persistent store into tools tools_condition: Utility function for conditional routing based on tool calls
Typical Usage
Classes:
Name | Description |
---|---|
InjectedState |
Annotation for injecting graph state into tool arguments. |
InjectedStore |
Annotation for injecting persistent store into tool arguments. |
Functions:
Name | Description |
---|---|
tools_condition |
Conditional routing function for tool-calling workflows. |
InjectedState
¶
Bases: InjectedToolArg
Annotation for injecting graph state into tool arguments.
This annotation enables tools to access graph state without exposing state management details to the language model. Tools annotated with InjectedState receive state data automatically during execution while remaining invisible to the model's tool-calling interface.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
field
|
Optional[str]
|
Optional key to extract from the state dictionary. If None, the entire state is injected. If specified, only that field's value is injected. This allows tools to request specific state components rather than processing the full state structure. |
None
|
Example
from typing import List
from typing_extensions import Annotated, TypedDict
from langchain_core.messages import BaseMessage, AIMessage
from langchain_core.tools import tool
from langgraph.prebuilt import InjectedState, ToolNode
class AgentState(TypedDict):
messages: List[BaseMessage]
foo: str
@tool
def state_tool(x: int, state: Annotated[dict, InjectedState]) -> str:
'''Do something with state.'''
if len(state["messages"]) > 2:
return state["foo"] + str(x)
else:
return "not enough messages"
@tool
def foo_tool(x: int, foo: Annotated[str, InjectedState("foo")]) -> str:
'''Do something else with state.'''
return foo + str(x + 1)
node = ToolNode([state_tool, foo_tool])
tool_call1 = {"name": "state_tool", "args": {"x": 1}, "id": "1", "type": "tool_call"}
tool_call2 = {"name": "foo_tool", "args": {"x": 1}, "id": "2", "type": "tool_call"}
state = {
"messages": [AIMessage("", tool_calls=[tool_call1, tool_call2])],
"foo": "bar",
}
node.invoke(state)
Note
- InjectedState arguments are automatically excluded from tool schemas presented to language models
- ToolNode handles the injection process during execution
- Tools can mix regular arguments (controlled by the model) with injected arguments (controlled by the system)
- State injection occurs after the model generates tool calls but before tool execution
InjectedStore
¶
Bases: InjectedToolArg
Annotation for injecting persistent store into tool arguments.
This annotation enables tools to access LangGraph's persistent storage system without exposing storage details to the language model. Tools annotated with InjectedStore receive the store instance automatically during execution while remaining invisible to the model's tool-calling interface.
The store provides persistent, cross-session data storage that tools can use for maintaining context, user preferences, or any other data that needs to persist beyond individual workflow executions.
Warning
InjectedStore
annotation requires langchain-core >= 0.3.8
Example
from typing_extensions import Annotated
from langchain_core.tools import tool
from langgraph.store.memory import InMemoryStore
from langgraph.prebuilt import InjectedStore, ToolNode
@tool
def save_preference(
key: str,
value: str,
store: Annotated[Any, InjectedStore()]
) -> str:
"""Save user preference to persistent storage."""
store.put(("preferences",), key, value)
return f"Saved {key} = {value}"
@tool
def get_preference(
key: str,
store: Annotated[Any, InjectedStore()]
) -> str:
"""Retrieve user preference from persistent storage."""
result = store.get(("preferences",), key)
return result.value if result else "Not found"
Usage with ToolNode and graph compilation:
from langgraph.graph import StateGraph
from langgraph.store.memory import InMemoryStore
store = InMemoryStore()
tool_node = ToolNode([save_preference, get_preference])
graph = StateGraph(State)
graph.add_node("tools", tool_node)
compiled_graph = graph.compile(store=store) # Store is injected automatically
Cross-session persistence:
Note
- InjectedStore arguments are automatically excluded from tool schemas presented to language models
- The store instance is automatically injected by ToolNode during execution
- Tools can access namespaced storage using the store's get/put methods
- Store injection requires the graph to be compiled with a store instance
- Multiple tools can share the same store instance for data consistency
tools_condition
¶
tools_condition(
state: Union[
list[AnyMessage], dict[str, Any], BaseModel
],
messages_key: str = "messages",
) -> Literal["tools", "__end__"]
Conditional routing function for tool-calling workflows.
This utility function implements the standard conditional logic for ReAct-style agents: if the last AI message contains tool calls, route to the tool execution node; otherwise, end the workflow. This pattern is fundamental to most tool-calling agent architectures.
The function handles multiple state formats commonly used in LangGraph applications, making it flexible for different graph designs while maintaining consistent behavior.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
state
|
Union[list[AnyMessage], dict[str, Any], BaseModel]
|
The current graph state to examine for tool calls. Supported formats: - List of messages (for MessageGraph) - Dictionary containing a messages key (for StateGraph) - BaseModel instance with a messages attribute |
required |
messages_key
|
str
|
The key or attribute name containing the message list in the state. This allows customization for graphs using different state schemas. Defaults to "messages". |
'messages'
|
Returns:
Type | Description |
---|---|
Literal['tools', '__end__']
|
Either "tools" if tool calls are present in the last AI message, or "end" |
Literal['tools', '__end__']
|
to terminate the workflow. These are the standard routing destinations for |
Literal['tools', '__end__']
|
tool-calling conditional edges. |
Raises:
Type | Description |
---|---|
ValueError
|
If no messages can be found in the provided state format. |
Example
Basic usage in a ReAct agent:
from langgraph.graph import StateGraph
from langgraph.prebuilt import ToolNode, tools_condition
from typing_extensions import TypedDict
class State(TypedDict):
messages: list
graph = StateGraph(State)
graph.add_node("llm", call_model)
graph.add_node("tools", ToolNode([my_tool]))
graph.add_conditional_edges(
"llm",
tools_condition, # Routes to "tools" or "__end__"
{"tools": "tools", "__end__": "__end__"}
)
Custom messages key:
Note
This function is designed to work seamlessly with ToolNode and standard LangGraph patterns. It expects the last message to be an AIMessage when tool calls are present, which is the standard output format for tool-calling language models.
ValidationNode
¶
Bases: RunnableCallable
A node that validates all tools requests from the last AIMessage.
It can be used either in StateGraph with a "messages" key or in MessageGraph.
Note
This node does not actually run the tools, it only validates the tool calls, which is useful for extraction and other use cases where you need to generate structured output that conforms to a complex schema without losing the original messages and tool IDs (for use in multi-turn conversations).
Parameters:
Name | Type | Description | Default |
---|---|---|---|
schemas
|
Sequence[Union[BaseTool, Type[BaseModel], Callable]]
|
A list of schemas to validate the tool calls with. These can be any of the following: - A pydantic BaseModel class - A BaseTool instance (the args_schema will be used) - A function (a schema will be created from the function signature) |
required |
format_error
|
Optional[Callable[[BaseException, ToolCall, Type[BaseModel]], str]]
|
A function that takes an exception, a ToolCall, and a schema and returns a formatted error string. By default, it returns the exception repr and a message to respond after fixing validation errors. |
None
|
name
|
str
|
The name of the node. |
'validation'
|
tags
|
Optional[list[str]]
|
A list of tags to add to the node. |
None
|
Returns:
Type | Description |
---|---|
Union[Dict[str, List[ToolMessage]], Sequence[ToolMessage]]
|
A list of ToolMessages with the validated content or error messages. |
Example
from typing import Literal, Annotated
from typing_extensions import TypedDict
from langchain_anthropic import ChatAnthropic
from pydantic import BaseModel, field_validator
from langgraph.graph import END, START, StateGraph
from langgraph.prebuilt import ValidationNode
from langgraph.graph.message import add_messages
class SelectNumber(BaseModel):
a: int
@field_validator("a")
def a_must_be_meaningful(cls, v):
if v != 37:
raise ValueError("Only 37 is allowed")
return v
builder = StateGraph(Annotated[list, add_messages])
llm = ChatAnthropic(model="claude-3-5-haiku-latest").bind_tools([SelectNumber])
builder.add_node("model", llm)
builder.add_node("validation", ValidationNode([SelectNumber]))
builder.add_edge(START, "model")
def should_validate(state: list) -> Literal["validation", "__end__"]:
if state[-1].tool_calls:
return "validation"
return END
builder.add_conditional_edges("model", should_validate)
def should_reprompt(state: list) -> Literal["model", "__end__"]:
for msg in state[::-1]:
# None of the tool calls were errors
if msg.type == "ai":
return END
if msg.additional_kwargs.get("is_error"):
return "model"
return END
builder.add_conditional_edges("validation", should_reprompt)
graph = builder.compile()
res = graph.invoke(("user", "Select a number, any number"))
# Show the retry logic
for msg in res:
msg.pretty_print()
Classes:
Name | Description |
---|---|
HumanInterruptConfig |
Configuration that defines what actions are allowed for a human interrupt. |
ActionRequest |
Represents a request for human action within the graph execution. |
HumanInterrupt |
Represents an interrupt triggered by the graph that requires human intervention. |
HumanResponse |
The response provided by a human to an interrupt, which is returned when graph execution resumes. |
HumanInterruptConfig
¶
Bases: TypedDict
Configuration that defines what actions are allowed for a human interrupt.
This controls the available interaction options when the graph is paused for human input.
Attributes:
Name | Type | Description |
---|---|---|
allow_ignore |
bool
|
Whether the human can choose to ignore/skip the current step |
allow_respond |
bool
|
Whether the human can provide a text response/feedback |
allow_edit |
bool
|
Whether the human can edit the provided content/state |
allow_accept |
bool
|
Whether the human can accept/approve the current state |
ActionRequest
¶
Bases: TypedDict
Represents a request for human action within the graph execution.
Contains the action type and any associated arguments needed for the action.
Attributes:
Name | Type | Description |
---|---|---|
action |
str
|
The type or name of action being requested (e.g., "Approve XYZ action") |
args |
dict
|
Key-value pairs of arguments needed for the action |
HumanInterrupt
¶
Bases: TypedDict
Represents an interrupt triggered by the graph that requires human intervention.
This is passed to the interrupt
function when execution is paused for human input.
Attributes:
Name | Type | Description |
---|---|---|
action_request |
ActionRequest
|
The specific action being requested from the human |
config |
HumanInterruptConfig
|
Configuration defining what actions are allowed |
description |
Optional[str]
|
Optional detailed description of what input is needed |
Example
# Extract a tool call from the state and create an interrupt request
request = HumanInterrupt(
action_request=ActionRequest(
action="run_command", # The action being requested
args={"command": "ls", "args": ["-l"]} # Arguments for the action
),
config=HumanInterruptConfig(
allow_ignore=True, # Allow skipping this step
allow_respond=True, # Allow text feedback
allow_edit=False, # Don't allow editing
allow_accept=True # Allow direct acceptance
),
description="Please review the command before execution"
)
# Send the interrupt request and get the response
response = interrupt([request])[0]
HumanResponse
¶
Bases: TypedDict
The response provided by a human to an interrupt, which is returned when graph execution resumes.
Attributes:
Name | Type | Description |
---|---|---|
type |
Literal['accept', 'ignore', 'response', 'edit']
|
The type of response: - "accept": Approves the current state without changes - "ignore": Skips/ignores the current step - "response": Provides text feedback or instructions - "edit": Modifies the current state/content |
args |
Union[None, str, ActionRequest]
|
The response payload: - None: For ignore/accept actions - str: For text responses - ActionRequest: For edit actions with updated content |