ls、read_file、write_file、edit_file、glob 和 grep 等工具向智能体暴露文件系统界面。这些工具通过可插拔的后端运行。read_file 工具原生支持所有后端的图像文件(.png、.jpg、.jpeg、.gif、.webp),并以多模态内容块的形式返回。
沙盒和 LocalShellBackend 还提供 execute 工具。
本页面介绍如何选择后端、将不同路径路由到不同后端、实现自定义虚拟文件系统(例如 S3 或 Postgres)、添加策略钩子以及遵守后端协议。
快速开始
以下是一些可以快速与 deep agent 配合使用的预建文件系统后端:| 内置后端 | 描述 |
|---|---|
| 默认 | agent = create_deep_agent() 存储在状态中的临时数据。智能体的默认文件系统后端存储在 langgraph 状态中。注意此文件系统仅在_单个线程_内持久化。 |
| 本地文件系统持久化 | agent = create_deep_agent(backend=FilesystemBackend(root_dir="/Users/nh/Desktop/")) 这使 deep agent 可以访问本地机器的文件系统。您可以指定智能体可访问的根目录。注意所提供的 root_dir 必须是绝对路径。 |
| 持久化存储(LangGraph store) | agent = create_deep_agent(backend=lambda rt: StoreBackend(rt)) 这使智能体可以访问_跨线程持久化_的长期存储。非常适合存储适用于多次执行的长期记忆或指令。 |
| 沙盒 | agent = create_deep_agent(backend=sandbox) 在隔离环境中执行代码。沙盒提供文件系统工具以及用于运行 Shell 命令的 execute 工具。可选择 Modal、Daytona、Deno 或本地 VFS。 |
| 本地 Shell | agent = create_deep_agent(backend=LocalShellBackend(root_dir=".", env={"PATH": "/usr/bin:/bin"})) 直接在主机上进行文件系统和 Shell 执行。无隔离——仅在受控开发环境中使用。请参阅下方的安全注意事项。 |
| 复合 | 默认为临时存储,/memories/ 为持久化存储。复合后端具有最大灵活性。您可以指定文件系统中的不同路由指向不同后端。有关复合路由的即用示例,请参阅下方内容。 |
内置后端
StateBackend(临时存储)
- 将文件存储在当前线程的 LangGraph 智能体状态中。
- 通过检查点在同一线程的多个智能体轮次中持久化。
- 作为智能体写入中间结果的草稿本。
- 自动清除智能体可按块读回的大型工具输出。
FilesystemBackend(本地磁盘)
- 在可配置的
root_dir下读写真实文件。 - 您可以选择设置
virtual_mode=True以在root_dir下沙盒化和规范化路径。 - 使用安全路径解析,尽可能防止不安全的符号链接遍历,可使用 ripgrep 进行快速
grep。
- 本地机器上的项目
- CI 沙盒
- 挂载的持久化卷
LocalShellBackend(本地 Shell)
- 通过
execute工具扩展FilesystemBackend,用于在主机上运行 Shell 命令。 - 命令使用
subprocess.run(shell=True)直接在您的机器上运行,无沙盒。 - 支持
timeout(默认 120 秒)、max_output_bytes(默认 100,000)、env和inherit_env用于环境变量。 - Shell 命令使用
root_dir作为工作目录,但可以访问系统上的任何路径。
- 本地编码助手和开发工具
- 信任智能体时在开发阶段快速迭代
StoreBackend(LangGraph store)
When deploying to LangSmith Deployment, omit the
store parameter. The platform automatically provisions a store for your agent.- 将文件存储在运行时提供的 LangGraph
BaseStore中,实现跨线程的持久化存储。
- 当您已在使用配置了 LangGraph store 的运行时(例如 Redis、Postgres 或
BaseStore背后的云实现)。 - 当您通过 LangSmith Deployment 部署智能体时(会自动为您的智能体配置 store)。
CompositeBackend(路由器)
- 根据路径前缀将文件操作路由到不同的后端。
- 在列表和搜索结果中保留原始路径前缀。
- 当您希望为智能体提供临时存储和跨线程存储时,
CompositeBackend允许您同时提供StateBackend和StoreBackend。 - 当您有多个信息来源,并希望以单一文件系统的形式提供给智能体时。
- 例如:您在某个 Store 的
/memories/下存储了长期记忆,同时还有一个在/docs/提供文档的自定义后端。
- 例如:您在某个 Store 的
指定后端
- 将后端传递给
create_deep_agent(backend=...)。文件系统中间件将其用于所有工具。 - 您可以传递:
- 实现
BackendProtocol的实例(例如FilesystemBackend(root_dir=".")),或 - 工厂函数
BackendFactory = Callable[[ToolRuntime], BackendProtocol](适用于需要运行时的后端,如StateBackend或StoreBackend)。
- 实现
- 如果省略,默认为
lambda rt: StateBackend(rt)。
路由到不同后端
将命名空间的各部分路由到不同的后端。通常用于持久化/memories/* 并保持其他内容为临时存储。
/workspace/plan.md→StateBackend(临时)/memories/agent.md→FilesystemBackend,位于/deepagents/myagent下ls、glob、grep聚合结果并显示原始路径前缀。
- 较长的前缀优先(例如,路由
"/memories/projects/"可以覆盖"/memories/")。 - 对于 StoreBackend 路由,确保智能体运行时提供 store(
runtime.store)。
使用虚拟文件系统
构建自定义后端,将远程或数据库文件系统(例如 S3 或 Postgres)投影到工具命名空间中。 设计指南:- 路径是绝对路径(
/x/y.txt)。决定如何将它们映射到存储键/行。 - 高效实现
ls_info和glob_info(在可能的情况下使用服务器端列表,否则使用本地过滤)。 - 为缺失文件或无效正则表达式模式返回用户可读的错误字符串。
- 对于外部持久化,在结果中设置
files_update=None;只有状态内后端才应返回files_update字典。
- 表
files(path text primary key, content text, created_at timestamptz, modified_at timestamptz) - 将工具操作映射到 SQL:
ls_info使用WHERE path LIKE $1 || '%'glob_info在 SQL 中过滤或获取后在 Python 中应用 globgrep_raw可以按扩展名或最后修改时间获取候选行,然后扫描行
添加策略钩子
通过继承或包装后端来执行企业规则。 阻止对选定前缀的写入/编辑(继承方式):协议参考
后端必须实现BackendProtocol。
必需的端点:
ls_info(path: str) -> list[FileInfo]- 返回至少包含
path的条目。在可用时包含is_dir、size、modified_at。按path排序以获得确定性输出。
- 返回至少包含
read(file_path: str, offset: int = 0, limit: int = 2000) -> str- 返回带行号的内容。对于缺失文件,返回
"Error: File '/x' not found"。
- 返回带行号的内容。对于缺失文件,返回
grep_raw(pattern: str, path: Optional[str] = None, glob: Optional[str] = None) -> list[GrepMatch] | str- 返回结构化匹配。对于无效正则表达式,返回类似
"Invalid regex pattern: ..."的字符串(不要抛出异常)。
- 返回结构化匹配。对于无效正则表达式,返回类似
glob_info(pattern: str, path: str = "/") -> list[FileInfo]- 将匹配的文件作为
FileInfo条目返回(无匹配时返回空列表)。
- 将匹配的文件作为
write(file_path: str, content: str) -> WriteResult- 仅创建。发生冲突时,返回
WriteResult(error=...)。成功时,设置path;对于状态后端设置files_update={...};外部后端应使用files_update=None。
- 仅创建。发生冲突时,返回
edit(file_path: str, old_string: str, new_string: str, replace_all: bool = False) -> EditResult- 除非
replace_all=True,否则强制old_string的唯一性。如果未找到,返回错误。成功时包含occurrences。
- 除非
WriteResult(error, path, files_update)EditResult(error, path, files_update, occurrences)FileInfo,字段:path(必需),可选is_dir、size、modified_at。GrepMatch,字段:path、line、text。
将这些文档连接到 Claude、VSCode 等工具,通过 MCP 获取实时答案。

