Adapter ContractTutorials

Stage 6: Verify the Adapter

View as Markdown

Verify the minimum lifecycle and every claim in the selected Adapter Descriptor before publishing an adapter.

Prerequisites

Before you start, complete the following:

  1. Complete Stage 5: Register and discover the adapter so installed and explicit discovery both work.
  2. Install the adapter package into a test environment.
  3. Gather valid and invalid examples for every published settings, model, tool-definition, target, and extension schema.

Concepts Overview

NVIDIA NeMo Fabric 0.2 runs adapter-contract checks through just test-python and just test-typescript; the installed adapter lifecycle and optional capability checks below remain manual.

Completing this checklist does not imply NVIDIA review, trust, certification, or verification.

To Verify the Adapter

Work through each step in order, verifying your progress at each checkpoint.

1. Verify the Minimum Profile

Run these checks against an installed adapter package:

  1. Discover the packaged *.fabric-adapter.json without importing adapter code. Also verify an explicit discovery.local_paths record for the development workflow.
  2. Run Fabric().plan(...) with the smallest valid configuration and inspect the selected descriptor and projected AgentConfig.
  3. Confirm that planning rejects one unsupported normalized field and invalid data for every published settings, model, tool-definition, target, and extension schema.
  4. Run doctor(...) with both satisfied and missing runtime requirements.
  5. Exercise typed request projection, at least two ordered successful invocations, target failure, and stop.
  6. Exercise partial-start failure, invocation transport failure, malformed or untyped AgentRunResult, and end-of-file cleanup without exposing secrets.
  7. Run two independent Fabric runtimes and confirm that they do not share mutable target state.

Preserve runtime, invocation, and request IDs as opaque values. Check logs and persisted diagnostics for credential values, authorization headers, complete environment mappings, and arbitrary user input.

Success Check: The minimum profile passes end to end, and no log or diagnostic exposes secrets or raw user input.

2. Verify Declared Capabilities

Test each descriptor claim independently:

ClaimEvidence
Normalized config fieldOne accepted case and one unsupported or invalid case.
Adapter-owned schemaValid and invalid examples exercised through planning.
Runtime requirementdoctor(...) reports both satisfied and missing states.
Telemetry outputThe output is produced and correlated to the intended invocation.
Relay-backed streamOrdinary invoke completes while correlated Agent Trajectory Observability Format (ATOF) records reach Runtime.invoke_stream().
Native OpenAI streamEmpty and multi-chunk streams, invalid records, early close, a separate terminal value, and exactly one target invocation.

Do not claim reserved cancellation, update, or service capabilities until the installed NeMo Fabric runtime binding exposes and tests the corresponding adapter operation.

Success Check: Every declared capability has an accepted case and a rejected or invalid case, and no reserved capability is claimed.

3. Record the Result

Record the exact adapter package version, contract_version, NeMo Fabric version, minimum-profile result, test environment, and every optional capability as supported or unsupported. Link the evidence to the adapter release so a later release does not inherit the claim automatically.

Success Check: The recorded result names the exact versions and links its evidence to the specific adapter release.

Summary

In this tutorial, you have:

  • Verified the minimum profile against an installed adapter package.
  • Tested each declared capability with an accepted case and a rejected case.
  • Recorded the result and linked evidence to the adapter release.

Next Steps

With the adapter verified, compare it against maintained implementations:

Examples and References

Compare the finished adapter with the closest maintained implementation.

Adapter Contract overview

Revisit the full contract surface and the six-stage authoring flow.