Agent.getMetadata()

La méthode .getMetadata() récupère les métadonnées configurées pour un Agent et les résout si elles sont définies par une fonction. Utilisez les métadonnées pour classer les Agents dans les clients sans encoder ces informations dans l’ID ou le nom de l’Agent.

Exemple d’utilisation

await agent.getMetadata()

Paramètres

options?:

{ requestContext?: RequestContext }

= {}

Objet de configuration facultatif contenant le contexte de requête.

{ requestContext?: RequestContext }

requestContext?:

RequestContext

Contexte de requête transmis aux fonctions de métadonnées dynamiques. Ignoré lorsque les métadonnées sont statiques.

Valeur renvoyée

metadata:

Record<string, unknown> | Promise<Record<string, unknown>>

Métadonnées configurées pour l’Agent, ou undefined si aucune métadonnée n’a été configurée. Elles sont renvoyées directement ou sous la forme d’une Promise qui se résout avec les métadonnées lorsqu’elles sont définies par une fonction.

Exemple d’utilisation étendu

Métadonnées statiques :

src/mastra/agents/support-agent.ts

import { Agent } from '@mastra/core/agent'

export const supportAgent = new Agent({
  id: 'support-agent',
  name: 'Support Agent',
  instructions: 'You help customers with support requests.',
  model: 'openai/gpt-5.6-sol',
  metadata: { type: 'support' },
})

const metadata = supportAgent.getMetadata()

Métadonnées dynamiques résolues à partir du contexte de requête :

src/mastra/agents/support-agent.ts

import { Agent } from '@mastra/core/agent'

export const supportAgent = new Agent({
  id: 'support-agent',
  name: 'Support Agent',
  instructions: 'You help customers with support requests.',
  model: 'openai/gpt-5.6-sol',
  metadata: ({ requestContext }) => ({
    type: 'support',
    tenant: requestContext.get('tenant'),
  }),
})

const metadata = await supportAgent.getMetadata({ requestContext })

Voir aussi

• Présentation des Agents
• Contexte de requête