AgentFSFilesystem

AgentFS SDK を介して、ファイルを Turso/SQLite データベースに保存します。ファイルはセッションをまたいでローカル SQLite データベースに保持されるため、外部クラウドサービスなしで Agent に永続ストレージを提供できます。インターフェースの詳細は、WorkspaceFilesystem インターフェースを参照してください。

インストール

npm

npm install @mastra/agentfs

pnpm

pnpm add @mastra/agentfs

Yarn

yarn add @mastra/agentfs

Bun

bun add @mastra/agentfs

使用方法

Workspace に AgentFSFilesystem を追加して Agent に割り当てます。AgentFSFilesystem クラスのインスタンス化時には、agentId、path、agent のいずれか1つ以上を指定する必要があります。

import { Agent } from '@mastra/core/agent'
import { Workspace } from '@mastra/core/workspace'
import { AgentFSFilesystem } from '@mastra/agentfs'

const workspace = new Workspace({
  filesystem: new AgentFSFilesystem({
    agentId: 'my-agent',
  }),
})

const agent = new Agent({
  id: 'file-agent',
  name: 'file-agent',
  model: 'openai/gpt-5.6-sol',
  workspace,
})

データベースパスを明示的に指定する

デフォルトでは、データベースは .agentfs ディレクトリ内に agentId をファイル名として保存されます。カスタムのデータベースパスも指定できます。

import { AgentFSFilesystem } from '@mastra/agentfs'

const filesystem = new AgentFSFilesystem({
  path: '/data/my-agent.db',
})

事前に開いた AgentFS インスタンスを使用する

AgentFS のライフサイクルを自分で管理する場合は、次のように設定します。

import { AgentFS } from 'agentfs-sdk'
import { AgentFSFilesystem } from '@mastra/agentfs'

const agent = await AgentFS.open({ id: 'my-agent' })

const filesystem = new AgentFSFilesystem({
  agent, // caller manages open/close
})

コンストラクターパラメーター

agentId、path、agent のいずれか1つ以上を指定する必要があります。

agentId?:

string

Agent ID。.agentfs/<agentId>.db にデータベースを作成します。

path?:

string

明示的なデータベースファイルパス（agentId の代替）。

agent?:

AgentFS

事前に開いた AgentFS インスタンス。指定した場合、呼び出し元がライフサイクル（open/close）を管理します。

id?:

string

= Auto-generated

この Filesystem インスタンスの一意な識別子。

displayName?:

string

= 'AgentFS'

UI に表示するわかりやすい名前。

icon?:

FilesystemIcon

= 'database'

UI に表示するアイコンの識別子。

description?:

string

UI に表示する Filesystem の短い説明。

readOnly?:

boolean

= false

true の場合、すべての書き込み操作を禁止します。

プロパティ

id:

string

Filesystem インスタンスの識別子。

name:

string

Provider 名（'AgentFSFilesystem'）。

provider:

string

Provider 識別子（'agentfs'）。

readOnly:

boolean | undefined

Filesystem が読み取り専用モードかどうか。