About

Use this section when an agent framework, orchestration layer, SDK, or provider adapter owns the tool and LLM call sites that need NeMo Flow instrumentation.

Framework integrations differ from direct application instrumentation because the integration often does not own the full invocation. A framework may control scheduling, retries, streaming, callback signatures, provider payloads, and internal object lifetimes. The integration has to choose the best available boundary without changing framework behavior.

Prefer a managed execution wrapper around a stable tool or LLM callback. When that is not possible, use explicit lifecycle calls, standalone guardrail or intercept helpers, or mark events.

Start Here

Use these signals to decide whether this documentation path matches your current task.

• Maintain a framework integration for NeMo Flow

• Need to instrument calls without rewriting framework internals

• Need to handle provider-specific request or response payloads

• Need to keep non-serializable framework objects outside NeMo Flow payloads

• Are building or reviewing third-party integration patches

If you own the application call sites directly, use Instrument Applications first.

Guides

Use these guide links to move from the overview into task-specific instructions.

• Basic Guide: Adding Scopes shows how framework request and run hooks become NeMo Flow ownership boundaries.

• Basic Guide: Wrap Tool Calls explains where to place managed tool wrappers and tool lifecycle fallbacks.

• Basic Guide: Wrap LLM Calls explains where to place managed provider wrappers, model names, streaming behavior, and LLM lifecycle fallbacks.

• Advanced Guide: Handle Non-Serializable Data shows how to keep clients, streams, callbacks, and SDK objects outside JSON payloads.

• Advanced Guide: Using Codecs explains typed value codecs for framework-facing wrappers.

• Advanced Guide: Provider Codecs explains provider request and response codecs for normalized middleware and event annotations.

• Advanced Guide: Provider Response Codecs focuses on response-only annotations for subscribers and exporters.

• Code Examples collects fallback APIs, mark events, and repository patch workflow examples.

Start by identifying the framework’s stable tool and LLM boundaries. Prefer managed execution wrappers wherever the framework exposes a callback that NeMo Flow can own. Use explicit API calls only when the framework owns invocation internally but exposes reliable start and finish hooks.

Validate that application-visible framework behavior does not change. Then confirm that events share the expected root scope, middleware runs exactly once per managed call, and non-serializable framework objects remain in framework-owned storage.