Mastra Client SDK
Mastra Client SDK は、クライアント環境から Mastra Server とやり取りするための、シンプルで型安全なインターフェースを提供します。
使用例
lib/mastra/mastra-client.ts
import { MastraClient } from "@mastra/client-js";
export const mastraClient = new MastraClient({
baseUrl: "http://localhost:4111/",
});パラメータ
baseUrl:
string
Mastra API のベース URL。すべてのリクエストはこの URL を基準として送信されます。
retries?:
number
= 3
エラーをスローする前に失敗したリクエストを再試行する回数。
backoffMs?:
number
= 300
失敗したリクエストを再試行する前の初期遅延時間（ミリ秒）。この値は再試行のたびに倍増します（指数バックオフ）。
maxBackoffMs?:
number
= 5000
最大バックオフ時間（ミリ秒）。再試行間の待機が長くなりすぎるのを防ぎます。
headers?:
Record<string, string>
すべてのリクエストに付与するカスタム HTTP ヘッダーを含むオブジェクト。
credentials?:
"omit" | "same-origin" | "include"
リクエストのクレデンシャルモード。詳細は https://developer.mozilla.org/en-US/docs/Web/API/Request/credentials を参照してください。
メソッド
getAgents():
Promise<Record<string, GetAgentResponse>>
利用可能なすべてのエージェントインスタンスを返します。
getAgent(agentId):
Agent
ID を指定して特定のエージェントインスタンスを取得します。
getMemoryThreads(params):
Promise<StorageThreadType[]>
指定したリソースとエージェントのメモリスレッドを取得します。`resourceId` と `agentId` が必要です。
createMemoryThread(params):
Promise<MemoryThread>
指定したパラメータで新規メモリスレッドを作成します。
getMemoryThread(threadId):
Promise<MemoryThread>
ID を指定して特定のメモリスレッドを取得します。
saveMessageToMemory(params):
Promise<void>
1 件以上のメッセージをメモリシステムに保存します。
getMemoryStatus():
Promise<MemoryStatus>
メモリシステムの現在のステータスを返します。
getTools():
Record<string, Tool>
利用可能なすべてのツールを返します。
getTool(toolId):
Tool
ID を指定して特定のツールインスタンスを取得します。
getWorkflows():
Record<string, Workflow>
利用可能なすべてのワークフローインスタンスを返します。
getWorkflow(workflowId):
Workflow
ID を指定して特定のワークフローインスタンスを取得します。
getVector(vectorName):
MastraVector
名前を指定してベクターストアのインスタンスを返します。
getLogs(params):
Promise<LogEntry[]>
指定したフィルタに一致するシステムログを取得します。
getLog(params):
Promise<LogEntry>
ID またはフィルタで特定のログエントリを取得します。
getLogTransports():
string[]
設定済みのログトランスポート種別の一覧を返します。