0
Fork 0
mirror of https://github.com/TanStack/ai.git synced 2026-11-16 19:38:41 +00:00
ai/docs/reference/interfaces/ProviderExecutedToolMetadata.md
github-actions[bot] f4f32bdcc2
docs: regenerate API documentation (#1195)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2026-08-22 08:16:20 +00:00

1.2 KiB

id title
ProviderExecutedToolMetadata ProviderExecutedToolMetadata

Interface: ProviderExecutedToolMetadata

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

Convention for tool-call metadata that marks a call as provider-executed — run by the provider's own infrastructure (e.g. Anthropic web_search / web_fetch server tools) rather than by the agent loop. Adapters set providerExecuted: true so that:

  1. The agent loop never tries to execute the call client-side (see isProviderExecutedToolCall usage in the chat engine), and
  2. The adapter can stash the raw provider result alongside it so the call — and its evidence — round-trips into the next turn's request.

Provider-specific payloads live under a namespaced key (e.g. anthropic), keeping this convention opaque to the framework core. The index signature preserves those per-adapter fields.

Indexable

[key: string]: unknown

Properties

providerExecuted?

optional providerExecuted?: boolean;

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