FilesystemProvider

FilesystemProvider 是套件用來向 MastraEditor 註冊檔案系統的介面。Editor 會在 Workspace 具現化時呼叫 createFilesystem(config)，並將已儲存 StorageWorkspaceRef 檔案系統設定中的 provider ID 作為查詢鍵。

內建的 local 檔案系統 Provider 會自動註冊。外部 Provider（例如 S3 或 GCS）則透過 MastraEditorConfig.filesystems 提供。

使用範例

src/mastra/index.ts

import { MastraEditor } from '@mastra/editor'
import { s3FilesystemProvider } from '@mastra/s3'

new MastraEditor({
  filesystems: {
    [s3FilesystemProvider.id]: s3FilesystemProvider,
  },
})

屬性

id:

string

唯一的 Provider 識別碼（例如 "local"、"s3"）。每個使用此 Provider 的已儲存 Workspace，其 StorageFilesystemConfig.provider 都必須與此值相符。

name:

string

供 UI 顯示、方便使用者閱讀的名稱。

description?:

string

Workspace 檔案系統選擇器中顯示的簡短說明。

configSchema?:

Record<string, unknown>

描述 Provider 專屬設定的 JSON Schema。UI 會用它呈現設定表單。

createFilesystem:

(config: TConfig) => WorkspaceFilesystem | Promise<WorkspaceFilesystem>

從已儲存的設定建立執行階段 WorkspaceFilesystem 執行個體。在 Workspace 具現化時呼叫。

實作 Provider

src/providers/my-filesystem.ts

import type { FilesystemProvider, WorkspaceFilesystem } from '@mastra/core/editor'

export const myFilesystemProvider: FilesystemProvider<{ bucket: string; region: string }> = {
  id: 'my-fs',
  name: 'My Filesystem',
  description: 'Object-store-backed filesystem.',
  configSchema: {
    type: 'object',
    required: ['bucket', 'region'],
    properties: {
      bucket: { type: 'string' },
      region: { type: 'string' },
    },
  },
  async createFilesystem(config): Promise<WorkspaceFilesystem> {
    return createMyFilesystem({ bucket: config.bucket, region: config.region })
  },
}

註冊後，管理員可在內嵌 Workspace 設定或已儲存的 StorageWorkspaceRef 中參照此 Provider。

相關內容

• Workspace：概念與完整範例。
• StorageWorkspaceRef：createFilesystem 使用的已儲存設定。
• SandboxProvider：用於執行命令的同類 Provider。
• MastraEditor 類別：Provider 登錄表。