Skip to content

docs: compare resources server APIs - #2325

Merged
ffrujeri merged 6 commits into
mainfrom
ffrujeri/docs-resources-server-apis
Aug 5, 2026
Merged

docs: compare resources server APIs#2325
ffrujeri merged 6 commits into
mainfrom
ffrujeri/docs-resources-server-apis

Conversation

@ffrujeri

@ffrujeri ffrujeri commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Document the Resources Server protocol landscape, including the seed/verify and reset/step base episode protocols and existing seed/verify extensions.
  • Clarify how Agent Server run() and responses() behavior maps to Resources Server lifecycle, verification, and transition APIs.
  • Explain direct HTTP, MCP, Gymnasium step-action, bespoke transition, and agent-embedded tool interactions.
  • Provide API contracts, implementation examples, state management, cleanup, YAML configuration, and matching built-in Agent Servers.
  • Add the guide to the Build Environments navigation.

Closes #1363

Test plan

  • Run npm run check from fern/

Signed-off-by: Felipe Vieira Frujeri <ffrujeri@nvidia.com>
@copy-pr-bot

copy-pr-bot Bot commented Aug 4, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

Signed-off-by: Felipe Vieira Frujeri <ffrujeri@nvidia.com>
@ffrujeri
ffrujeri marked this pull request as ready for review August 5, 2026 18:05
Signed-off-by: Felipe Vieira Frujeri <ffrujeri@nvidia.com>
Signed-off-by: Felipe Vieira Frujeri <ffrujeri@nvidia.com>
@ffrujeri
ffrujeri merged commit 7ecf567 into main Aug 5, 2026
10 checks passed
@ffrujeri
ffrujeri deleted the ffrujeri/docs-resources-server-apis branch August 5, 2026 22:06
OlegSudakov pushed a commit to OlegSudakov/Gym that referenced this pull request Aug 7, 2026
## Summary
- Document the Resources Server protocol landscape, including the
seed/verify and reset/step base episode protocols and existing
seed/verify extensions.
- Clarify how Agent Server `run()` and `responses()` behavior maps to
Resources Server lifecycle, verification, and transition APIs.
- Explain direct HTTP, MCP, Gymnasium step-action, bespoke transition,
and agent-embedded tool interactions.
- Provide API contracts, implementation examples, state management,
cleanup, YAML configuration, and matching built-in Agent Servers.
- Add the guide to the Build Environments navigation.

Closes NVIDIA-NeMo#1363

## Test plan
- [x] Run `npm run check` from `fern/`

---------

Signed-off-by: Felipe Vieira Frujeri <ffrujeri@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: add resources server verifier APIs

2 participants