Enhance documentation for Strands Agents integration#1205
Enhance documentation for Strands Agents integration#1205rapids-bot[bot] merged 3 commits intoNVIDIA:developfrom
Conversation
- Updated README.md to include support for Amazon Bedrock AgentCore and Strands Agents framework. - Modified installation guide to add for Strands Agents. - Clarified Strands framework description in frameworks-overview.md. - Improved example documentation for running workflows locally and serving AgentCore-compatible endpoints. - Updated bedrock_agentcore README to reference the installation guide. Signed-off-by: RanjitR <ranjitr@nvidia.com>
WalkthroughUpdated documentation and example READMEs to add and describe Amazon Bedrock AgentCore / Strands Agents support, adjust installation extras, reorganize the Strands demo workflow and links, replace an external install link with an internal guide, and increase two test Changes
Sequence Diagram(s)(Skipped — changes are documentation, demos, and minor test adjustments; no new runtime control-flow introduced that requires a sequence diagram.) Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20–30 minutes
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🧰 Additional context used📓 Path-based instructions (6)**/*.{md,rst,py}📄 CodeRabbit inference engine (.cursor/rules/general.mdc)
Files:
**/*.{md,rst}📄 CodeRabbit inference engine (.cursor/rules/general.mdc)
Files:
**/*.{py,js,ts,yaml,yml,json,md,rst}📄 CodeRabbit inference engine (.cursor/rules/general.mdc)
Files:
**/*.{py,md,rst}📄 CodeRabbit inference engine (.cursor/rules/general.mdc)
Files:
**/*⚙️ CodeRabbit configuration file
Files:
examples/**/*⚙️ CodeRabbit configuration file
Files:
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
🔇 Additional comments (4)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
README.md(1 hunks)docs/source/quick-start/installing.md(1 hunks)docs/source/reference/frameworks-overview.md(1 hunks)examples/frameworks/strands_demo/README.md(3 hunks)examples/frameworks/strands_demo/bedrock_agentcore/README.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (9)
**/*.{md,rst,py}
📄 CodeRabbit inference engine (.cursor/rules/general.mdc)
Use 'NVIDIA NeMo Agent toolkit' on first use, then 'NeMo Agent toolkit' for subsequent references
Files:
docs/source/quick-start/installing.mdexamples/frameworks/strands_demo/bedrock_agentcore/README.mdREADME.mdexamples/frameworks/strands_demo/README.mddocs/source/reference/frameworks-overview.md
**/*.{md,rst}
📄 CodeRabbit inference engine (.cursor/rules/general.mdc)
Use 'NeMo Agent Toolkit' (capitalize 'T') when the name appears in headings
Files:
docs/source/quick-start/installing.mdexamples/frameworks/strands_demo/bedrock_agentcore/README.mdREADME.mdexamples/frameworks/strands_demo/README.mddocs/source/reference/frameworks-overview.md
docs/**/*.{md,rst}
📄 CodeRabbit inference engine (.cursor/rules/general.mdc)
Never use deprecated names: Agent Intelligence toolkit, aiqtoolkit, AgentIQ, AIQ/aiq in documentation (unless intentionally referring to deprecated versions)
Files:
docs/source/quick-start/installing.mddocs/source/reference/frameworks-overview.md
**/*.{py,js,ts,yaml,yml,json,md,rst}
📄 CodeRabbit inference engine (.cursor/rules/general.mdc)
Indent with 4 spaces, never tabs, and ensure every file ends with a single newline
Files:
docs/source/quick-start/installing.mdexamples/frameworks/strands_demo/bedrock_agentcore/README.mdREADME.mdexamples/frameworks/strands_demo/README.mddocs/source/reference/frameworks-overview.md
docs/source/**/*.{md,rst}
📄 CodeRabbit inference engine (.cursor/rules/general.mdc)
docs/source/**/*.{md,rst}: Documentation must be clear and comprehensive, without TODOs, FIXMEs, or placeholder text
Ensure documentation is free of offensive or outdated terms
Ensure documentation is free of spelling mistakes and do not use words listed in ci/vale/styles/config/vocabularies/nat/reject.txt
Files:
docs/source/quick-start/installing.mddocs/source/reference/frameworks-overview.md
**/*.{py,md,rst}
📄 CodeRabbit inference engine (.cursor/rules/general.mdc)
Version numbers are derived automatically by setuptools-scm; never hard-code them in code or docs
Files:
docs/source/quick-start/installing.mdexamples/frameworks/strands_demo/bedrock_agentcore/README.mdREADME.mdexamples/frameworks/strands_demo/README.mddocs/source/reference/frameworks-overview.md
**/*
⚙️ CodeRabbit configuration file
**/*: # Code Review Instructions
- Ensure the code follows best practices and coding standards. - For Python code, follow
PEP 20 and
PEP 8 for style guidelines.- Check for security vulnerabilities and potential issues. - Python methods should use type hints for all parameters and return values (except for return values of
None,
in that situation no return type hint is needed).
Example:def my_function(param1: int, param2: str) -> bool: pass- For Python exception handling, ensure proper stack trace preservation:
- When re-raising exceptions: use bare
raisestatements to maintain the original stack trace,
and uselogger.error()(notlogger.exception()) to avoid duplicate stack trace output.- When catching and logging exceptions without re-raising: always use
logger.exception()
to capture the full stack trace information.Documentation Review Instructions - Verify that documentation and comments are clear and comprehensive. - Verify that the documentation doesn't contain any TODOs, FIXMEs or placeholder text like "lorem ipsum". - Verify that the documentation doesn't contain any offensive or outdated terms. - Verify that documentation and comments are free of spelling mistakes, ensure the documentation doesn't contain any
words listed in the
ci/vale/styles/config/vocabularies/nat/reject.txtfile, words that might appear to be
spelling mistakes but are listed in theci/vale/styles/config/vocabularies/nat/accept.txtfile are OK.Misc. - All code (except .mdc files that contain Cursor rules) should be licensed under the Apache License 2.0,
and should contain an Apache License 2.0 header comment at the top of each file.
- Confirm that copyright years are up-to date whenever a file is changed.
Files:
docs/source/quick-start/installing.mdexamples/frameworks/strands_demo/bedrock_agentcore/README.mdREADME.mdexamples/frameworks/strands_demo/README.mddocs/source/reference/frameworks-overview.md
docs/source/**/*
⚙️ CodeRabbit configuration file
This directory contains the source code for the documentation. All documentation should be written in Markdown format. Any image files should be placed in the
docs/source/_staticdirectory.
Files:
docs/source/quick-start/installing.mddocs/source/reference/frameworks-overview.md
examples/**/*
⚙️ CodeRabbit configuration file
examples/**/*: - This directory contains example code and usage scenarios for the toolkit, at a minimum an example should
contain a README.md or file README.ipynb.
- If an example contains Python code, it should be placed in a subdirectory named
src/and should
contain apyproject.tomlfile. Optionally, it might also contain scripts in ascripts/directory.- If an example contains YAML files, they should be placed in a subdirectory named
configs/. - If an example contains sample data files, they should be placed in a subdirectory nameddata/, and should
be checked into git-lfs.
Files:
examples/frameworks/strands_demo/bedrock_agentcore/README.mdexamples/frameworks/strands_demo/README.md
🧠 Learnings (8)
📚 Learning: 2025-11-24T18:56:53.109Z
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-11-24T18:56:53.109Z
Learning: Applies to **/*.{py,toml,yaml,yml} : Use abbreviations: 'nat' for API namespace and CLI tool, 'nvidia-nat' for package name, 'NAT' for environment variable prefixes and informal comments
Applied to files:
docs/source/quick-start/installing.md
📚 Learning: 2025-11-24T18:56:53.109Z
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-11-24T18:56:53.109Z
Learning: Applies to **/*.{md,rst,py} : Use 'NVIDIA NeMo Agent toolkit' on first use, then 'NeMo Agent toolkit' for subsequent references
Applied to files:
docs/source/quick-start/installing.mdexamples/frameworks/strands_demo/bedrock_agentcore/README.mdREADME.md
📚 Learning: 2025-11-24T18:56:53.109Z
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-11-24T18:56:53.109Z
Learning: Applies to packages/*/pyproject.toml : The pyproject.toml should declare a dependency on nvidia-nat or another package with a name starting with nvidia-nat-
Applied to files:
docs/source/quick-start/installing.md
📚 Learning: 2025-11-10T21:26:35.059Z
Learnt from: jiaxiangr
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 974
File: packages/nvidia_nat_all/pyproject.toml:39-39
Timestamp: 2025-11-10T21:26:35.059Z
Learning: In packages/nvidia_nat_all/pyproject.toml, workspace dependencies (nvidia-nat-* plugin packages) should NOT have version constraints because they are managed as workspace dependencies. Version constraints are only applied to the base nvidia-nat package and external dependencies, not to internal workspace packages.
Applied to files:
docs/source/quick-start/installing.md
📚 Learning: 2025-11-14T20:33:53.944Z
Learnt from: AnuradhaKaruppiah
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 1181
File: packages/nvidia_nat_test/tests/test_test_llm.py:419-484
Timestamp: 2025-11-14T20:33:53.944Z
Learning: The NVIDIA NeMo-Agent-Toolkit project uses pytest-asyncio in strict mode (the default), which requires pytest.mark.asyncio decorator on all async test functions. All async tests in packages/nvidia_nat_test/tests/test_test_llm.py consistently follow this pattern.
Applied to files:
docs/source/quick-start/installing.md
📚 Learning: 2025-11-24T18:56:53.109Z
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-11-24T18:56:53.109Z
Learning: Applies to docs/**/*.{md,rst} : Never use deprecated names: Agent Intelligence toolkit, aiqtoolkit, AgentIQ, AIQ/aiq in documentation (unless intentionally referring to deprecated versions)
Applied to files:
examples/frameworks/strands_demo/bedrock_agentcore/README.md
📚 Learning: 2025-11-24T18:56:53.109Z
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-11-24T18:56:53.109Z
Learning: Applies to **/*.{md,rst} : Use 'NeMo Agent Toolkit' (capitalize 'T') when the name appears in headings
Applied to files:
examples/frameworks/strands_demo/bedrock_agentcore/README.mdREADME.md
📚 Learning: 2025-08-22T20:29:13.433Z
Learnt from: AnuradhaKaruppiah
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 701
File: examples/evaluation_and_profiling/simple_calculator_eval/src/nat_simple_calculator_eval/configs/config-with-custom-post-process.yml:16-18
Timestamp: 2025-08-22T20:29:13.433Z
Learning: In the NeMo-Agent-Toolkit project, configuration consistency across example files is prioritized over removing unused config options, even when those options aren't currently implemented in the runtime.
Applied to files:
README.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: CI Pipeline / Check
🔇 Additional comments (4)
README.md (1)
52-52: Align toolkit naming with coding guidelines.Per coding guidelines, subsequent references to the toolkit should use lowercase 't' ("NeMo Agent toolkit"), reserving uppercase 'T' for headings only. This line uses "NeMo Agent Toolkit" (uppercase), which is inconsistent with other files like
docs/source/quick-start/installing.mdanddocs/source/reference/frameworks-overview.mdthat correctly use lowercase 't'.Please verify and update this file to use "NVIDIA NeMo Agent toolkit" (first use) and "NeMo Agent toolkit" (subsequent uses), with uppercase 'T' only in headings like line 20.
Based on learnings, the naming convention is: "NVIDIA NeMo Agent toolkit" (first use), then "NeMo Agent toolkit" (lowercase 't') for subsequent references, with "NeMo Agent Toolkit" (uppercase 'T') used only in headings.
docs/source/quick-start/installing.md (1)
55-55: New Strands distribution entry is well-integrated.The new
nvidia-nat[strands]distribution entry follows the established pattern and is correctly positioned alphabetically. The link to Strands Agents is accurate. The naming and formatting are consistent with other entries in this section.examples/frameworks/strands_demo/bedrock_agentcore/README.md (1)
37-37: Internal Install Guide reference is well-applied.The replacement of an external URL with an internal relative path to the Install Guide is a good maintainability improvement. The relative path
../../../../docs/source/quick-start/installing.md#install-from-sourceis correctly calculated from this file's location and accurately references the installation instructions section. This aligns with the broader PR objective to consolidate documentation references.examples/frameworks/strands_demo/README.md (1)
29-29: Section renaming and AgentCore guidance improvements are well-coordinated.The renaming to "Run the Workflow Locally" and "Test and serve AgentCore-compatible endpoints locally" effectively clarifies the distinction between local testing and AWS cloud deployment. The addition of line 103 with a cross-reference to the bedrock AgentCore deployment guide provides good user navigation. The updated description at line 98 correctly clarifies that
agentcore_config.ymldefines local endpoints compatible with AgentCore format requirements, not actual AWS deployment. These changes align well with the PR's objective to improve deployment workflow documentation.Also applies to: 31-31, 76-76, 95-95, 103-103
Signed-off-by: Bryan Bednarski <bbednarski@nvidia.com>
bbednarski9
added
doc
bbednarski9
left a comment
bbednarski9
left a comment
There was a problem hiding this comment.
Look good to me. Updated the unit test that had an intermittent failure as well. Getting this merged today for AWS blog post
|
/ok to test 864fc46 |
…clarity for AgentCore and GPU sizing steps Signed-off-by: RanjitR <ranjitr@nvidia.com>
bbednarski9
left a comment
bbednarski9
left a comment
There was a problem hiding this comment.
final changes to docs look good
|
/merge |
Closes ## By Submitting this PR I confirm: - I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/NeMo-Agent-Toolkit/blob/develop/docs/source/resources/contributing.md). - We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license. - Any contribution which contains commits that are not Signed-Off will not be accepted. - When the PR is ready for review, new or existing tests cover these changes. - When the PR is ready for review, the documentation is up to date with these changes. ## Summary by CodeRabbit * **New Features** * Added support for Amazon Bedrock AgentCore and Strands Agents framework. * **Documentation** * Added Strands distribution/install entry and local install guidance. * Updated framework overview and example guides: clarified Strands usage, renamed/reordered "Run the Workflow" to "Run the Workflow Locally", expanded local-run commands and AgentCore deployment guidance, replaced external install link with internal install guide. * **Tests** * Increased token budget in Strands integration tests. <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> Authors: - RanjitR (https://github.com/ronjer30) - Bryan Bednarski (https://github.com/bbednarski9) Approvers: - Bryan Bednarski (https://github.com/bbednarski9) URL: NVIDIA#1205
Closes ## By Submitting this PR I confirm: - I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/NeMo-Agent-Toolkit/blob/develop/docs/source/resources/contributing.md). - We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license. - Any contribution which contains commits that are not Signed-Off will not be accepted. - When the PR is ready for review, new or existing tests cover these changes. - When the PR is ready for review, the documentation is up to date with these changes. ## Summary by CodeRabbit * **New Features** * Added support for Amazon Bedrock AgentCore and Strands Agents framework. * **Documentation** * Added Strands distribution/install entry and local install guidance. * Updated framework overview and example guides: clarified Strands usage, renamed/reordered "Run the Workflow" to "Run the Workflow Locally", expanded local-run commands and AgentCore deployment guidance, replaced external install link with internal install guide. * **Tests** * Increased token budget in Strands integration tests. <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> Authors: - RanjitR (https://github.com/ronjer30) - Bryan Bednarski (https://github.com/bbednarski9) Approvers: - Bryan Bednarski (https://github.com/bbednarski9) URL: NVIDIA#1205 Signed-off-by: Sangharsh Aglave <aglave@synopsys.com>
2 participants
Updated documentation to highlight Strands Agents framework support, including moving it from roadmap to new features in README.md, adding nvidia-nat[strands] to installation guide, and improving example documentation for local workflow execution and AgentCore deployment. Standardized links and framework descriptions across all Strands-related documentation
Description
Closes
By Submitting this PR I confirm:
Summary by CodeRabbit
New Features
Documentation
Tests
✏️ Tip: You can customize this high-level summary in your review settings.