Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Agentium 4.0.0 · Upgrade from 3.x.
Public agent filesystem signatures and configuration in @agentium/core 4.0.0.
@agentium/core. Read the agent filesystem guide for setup and behavior, or return to the package reference.
A ? marks an optional field. These are declarations for lookup; run the examples in the linked guide. Follow related-type links for Agentium types and source links for imported dependency types.
export interface AgentFile {
path: string;
content: string;
updatedAt: number;
version: number;
}
/**
* Durable text store for notes the agent writes for its future self.
* Not the host disk — that is FileSystemToolkit / workspace tools.
*/
export declare class AgentFileSystem {
constructor(config?: AgentFileSystemConfig);
resolveNamespace(ctx: {
userId?: string;
agentId?: string;
sessionId?: string;
}): string;
writeFile(path: string, content: string, ctx: {
userId?: string;
agentId?: string;
sessionId?: string;
}, expectedVersion?: number): Promise<AgentFile>;
readFile(path: string, ctx: {
userId?: string;
agentId?: string;
sessionId?: string;
}): Promise<AgentFile | null>;
listFiles(ctx: {
userId?: string;
agentId?: string;
sessionId?: string;
}): Promise<string[]>;
searchContent(query: string, ctx: {
userId?: string;
agentId?: string;
sessionId?: string;
}): Promise<Array<{
path: string;
snippet: string;
}>>;
deleteFile(path: string, ctx: {
userId?: string;
agentId?: string;
sessionId?: string;
}): Promise<boolean>;
getTools(): ToolDef[];
}
AgentFile, AgentFileSystemConfig, ToolDef.
export interface AgentFileSystemConfig {
storage?: StorageDriver;
/** Namespace prefix. `{userId}` / `{agentId}` / `{sessionId}` are substituted. Default: `fs/{agentId}/{userId}` */
namespace?: string;
maxFileBytes?: number;
maxNamespaceBytes?: number;
}
StorageDriver.