Docs
CodeRabbit
Cloudflare
AG Grid
SerpAPI
Netlify
OpenRouter
Neon
WorkOS
Clerk
Electric
PowerSync
Sentry
Railway
Prisma
Strapi
Unkey
CodeRabbit
Cloudflare
AG Grid
SerpAPI
Netlify
OpenRouter
Neon
WorkOS
Clerk
Electric
PowerSync
Sentry
Railway
Prisma
Strapi
Unkey
Persistence (Advanced)
Embeddings
Reranking
Evaluate
Sandboxes (Advanced)
Class References
Function References
Interface References
Type Alias References
Variable References
Interface References

ToolCall

Defined in: packages/ai/src/types.ts:194

AG-UI ToolCall with typed metadata. function.arguments is a JSON string.

Extends

  • Omit<AGUIToolCall, "metadata">

Type Parameters

TMetadata

TMetadata = unknown

Properties

metadata?

ts
optional metadata?: TMetadata;
optional metadata?: TMetadata;

Defined in: packages/ai/src/types.ts:201

Provider-specific metadata to carry through the tool call lifecycle. Typed per-adapter via TToolCallMetadata. For example, @tanstack/ai-gemini sets this to { thoughtSignature?: string }.