File System

Read, write, list, and inspect local files. All paths are sandboxed to a basePath directory, preventing traversal attacks. Shortcut on Agent: workspace: { path: "./data", mode: "read" } enables read-only workspace tools. Choose mode: "write" explicitly for writes. Path checks are not an OS sandbox. That is host disk. Durable notes for the agent’s future self are a different switch: filesystem: true (agent_fs_* tools). See Harness.

Quick Start

import { Agent, openai } from "@agentium/core";
import { FileSystemToolkit } from "@agentium/core/toolkits";

const fsTk = new FileSystemToolkit({
  basePath: "./data",
  allowWrite: true,
});

const agent = new Agent({
  name: "file-manager",
  model: openai(process.env.OPENAI_MODEL ?? "gpt-6.1-sol"),
  instructions: "Help manage files in the data directory.",
  tools: [...fsTk.getTools()],
});

const result = await agent.run("List all files in the data directory");

Config

string

Root directory for file access. All paths are resolved relative to this. Prevents directory traversal.

boolean

default:"false"

Enable the fs_write_file tool. Disabled by default for safety.

Tools

Tool	Description
`fs_read_file`	Read the contents of a file.
`fs_list_directory`	List files and subdirectories. Supports recursive listing.
`fs_file_info`	Get file metadata (size, type, modified/created dates).
`fs_write_file`	Write or append to a file. Only available when `allowWrite: true`.

Enable allowWrite only when necessary. Always set a basePath to restrict file access.

Find an integration

Voice and call adapters

Sandbox and telemetry

Providers and services

Protocols and devices

Quick Start

Config

Tools

​Quick Start

​Config

​Tools

Quick Start

Config

Tools