Skip to content

docs: clarify that function groups can be used as part of tool_name list#1092

Merged
rapids-bot[bot] merged 1 commit intoNVIDIA:release/1.3from
willkill07:wkk_clarify-tool_names
Oct 23, 2025
Merged

docs: clarify that function groups can be used as part of tool_name list#1092
rapids-bot[bot] merged 1 commit intoNVIDIA:release/1.3from
willkill07:wkk_clarify-tool_names

Conversation

@willkill07
Copy link
Member

@willkill07 willkill07 commented Oct 23, 2025

Description

Before, this was only mentioned in the function groups documentation.
Surface this to agent documentation and cursor rules.

Closes

By Submitting this PR I confirm:

  • I am familiar with the Contributing Guidelines.
  • 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

    • tool_names parameter now accepts function groups in addition to individual functions configured in YAML.
    • Added benign_fallback_data_path configuration option for enhanced offline-mode data handling.
  • Documentation

    • Updated agent workflow guidance to reflect expanded tool_names capabilities across ReAct, ReWOO, and Tool-Calling agents.

Signed-off-by: Will Killian <wkillian@nvidia.com>
@willkill07 willkill07 self-assigned this Oct 23, 2025
@willkill07 willkill07 requested a review from a team as a code owner October 23, 2025 13:13
@willkill07 willkill07 added doc Improvements or additions to documentation non-breaking Non-breaking change labels Oct 23, 2025
@coderabbitai
Copy link

coderabbitai bot commented Oct 23, 2025

Walkthrough

The PR updates documentation across multiple agent workflow files to clarify that the tool_names parameter accepts both individual functions and function groups from YAML configuration. One example also adds configuration for benign_fallback_data_path for offline-mode data handling.

Changes

Cohort / File(s) Change Summary
Agent Guidance & Rules
.cursor/rules/nat-agents/general.mdc
Updated ReAct Agent guidance to specify that tool_names accepts "list of YAML-defined functions or function groups" instead of just "functions."
Workflow Documentation
docs/source/workflows/about/react-agent.md, docs/source/workflows/about/rewoo-agent.md, docs/source/workflows/about/tool-calling-agent.md
Expanded tool_names descriptions across three agent workflow docs to include "function groups" in addition to individual functions configured in YAML.
Example Documentation
examples/advanced_agents/alert_triage_agent/README.md, examples/agents/rewoo/README.md
Updated configurable options documentation for tool_names to reference "functions or function groups" instead of functions alone; alert triage example also adds benign_fallback_data_path configuration.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The pull request title "docs: clarify that function groups can be used as part of tool_name list" is fully related to the changeset and accurately describes the main change. The title uses the imperative mood with the verb "clarify" and is sufficiently descriptive, explaining that the documentation is being updated to clarify support for function groups in the tool_name list. The raw summary confirms this is the primary change across multiple documentation files and cursor rules. The title exceeds the stated character limit by 2 characters (74 vs. ~72), which is a minor overage given the approximate nature of the guideline.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cc2b84b and 95b0657.

📒 Files selected for processing (6)
  • .cursor/rules/nat-agents/general.mdc (1 hunks)
  • docs/source/workflows/about/react-agent.md (1 hunks)
  • docs/source/workflows/about/rewoo-agent.md (1 hunks)
  • docs/source/workflows/about/tool-calling-agent.md (1 hunks)
  • examples/advanced_agents/alert_triage_agent/README.md (1 hunks)
  • examples/agents/rewoo/README.md (1 hunks)
🧰 Additional context used
📓 Path-based instructions (8)
{docs/source/**/*.md,**/README.@(md|ipynb)}

📄 CodeRabbit inference engine (.cursor/rules/general.mdc)

{docs/source/**/*.md,**/README.@(md|ipynb)}: Use the full name “NVIDIA NeMo Agent toolkit” on first use in documentation, then “NeMo Agent toolkit”; in headings use “NeMo Agent Toolkit” (capital T)
Do not use deprecated names (Agent Intelligence toolkit, aiqtoolkit, AgentIQ, AIQ/aiq) in documentation unless explicitly referring to deprecated names
Never use “NAT”/“nat” abbreviations in documentation
Documentation must be clear/comprehensive; avoid TODOs/FIXMEs/placeholders; avoid offensive/outdated terms; ensure spelling is correct

Files:

  • docs/source/workflows/about/react-agent.md
  • docs/source/workflows/about/tool-calling-agent.md
  • docs/source/workflows/about/rewoo-agent.md
  • examples/advanced_agents/alert_triage_agent/README.md
  • examples/agents/rewoo/README.md
docs/source/**/*.md

📄 CodeRabbit inference engine (.cursor/rules/general.mdc)

docs/source/**/*.md: Documentation sources are Markdown files under docs/source
Surround code entities with backticks in docs to avoid Vale false positives
Do not use words listed in ci/vale/styles/config/vocabularies/nat/reject.txt; accepted words in accept.txt are allowed

Files:

  • docs/source/workflows/about/react-agent.md
  • docs/source/workflows/about/tool-calling-agent.md
  • docs/source/workflows/about/rewoo-agent.md
{**/*.py,**/*.sh,**/*.md,**/*.toml,**/*.y?(a)ml,**/*.json,**/*.txt,**/*.ini,**/*.cfg,**/*.ipynb}

📄 CodeRabbit inference engine (.cursor/rules/general.mdc)

{**/*.py,**/*.sh,**/*.md,**/*.toml,**/*.y?(a)ml,**/*.json,**/*.txt,**/*.ini,**/*.cfg,**/*.ipynb}: Every file must start with the standard SPDX Apache-2.0 header
Confirm copyright years are up to date when a file is changed
All source files must include the SPDX Apache-2.0 header template (copy from an existing file)

Files:

  • docs/source/workflows/about/react-agent.md
  • docs/source/workflows/about/tool-calling-agent.md
  • docs/source/workflows/about/rewoo-agent.md
  • examples/advanced_agents/alert_triage_agent/README.md
  • examples/agents/rewoo/README.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.
    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 raise statements to maintain the original stack trace,
      and use logger.error() (not logger.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.txt file, words that might appear to be
spelling mistakes but are listed in the ci/vale/styles/config/vocabularies/nat/accept.txt file 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/workflows/about/react-agent.md
  • docs/source/workflows/about/tool-calling-agent.md
  • docs/source/workflows/about/rewoo-agent.md
  • examples/advanced_agents/alert_triage_agent/README.md
  • examples/agents/rewoo/README.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/_static directory.

Files:

  • docs/source/workflows/about/react-agent.md
  • docs/source/workflows/about/tool-calling-agent.md
  • docs/source/workflows/about/rewoo-agent.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 a pyproject.toml file. Optionally, it might also contain scripts in a scripts/ 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 named data/, and should
    be checked into git-lfs.

Files:

  • examples/advanced_agents/alert_triage_agent/README.md
  • examples/agents/rewoo/README.md
.cursor/rules/**/*.mdc

📄 CodeRabbit inference engine (.cursor/rules/cursor-rules.mdc)

.cursor/rules/**/*.mdc: Place all Cursor rule files under PROJECT_ROOT/.cursor/rules/
Name rule files in kebab-case, always using the .mdc extension, with descriptive filenames
Rule descriptions must start with the phrase: 'Follow these rules when'
Descriptions should specify clear trigger conditions (e.g., when the user's request meets certain criteria)
Use precise action verbs in descriptions (e.g., creating, modifying, implementing, configuring, adding, installing, evaluating)
Descriptions should be comprehensive but concise
Use consistent project terminology in descriptions (e.g., NAT workflows, NAT CLI commands)
Proofread descriptions for typos and grammar
Avoid overly narrow descriptions when rules cover multiple related scenarios
Prefer the 'user's request involves' phrasing pattern in descriptions
Rule files must include the specified frontmatter structure: description (string), optional globs, and alwaysApply (boolean), followed by markdown content

Files:

  • .cursor/rules/nat-agents/general.mdc
.cursor/rules/*/general.mdc

📄 CodeRabbit inference engine (.cursor/rules/cursor-rules.mdc)

.cursor/rules/*/general.mdc: Each topic subdirectory must include a general.mdc file with overarching guidelines
general.mdc must include a 'Referenced Documentation' section listing docs with names, links (mdc:path/...), and brief descriptions, and main rules should reference this section

Files:

  • .cursor/rules/nat-agents/general.mdc
🔇 Additional comments (7)
docs/source/workflows/about/react-agent.md (1)

87-87: Documentation update looks good.

Line 87 correctly clarifies that tool_names accepts "functions or function groups" configured in the YAML file, matching the PR objective and providing clearer guidance to users.

examples/agents/rewoo/README.md (1)

90-90: Documentation update is consistent and clear.

Line 90 properly clarifies that tool_names accepts both functions and function groups, aligning with the other documentation updates in this PR and providing users with accurate configuration guidance.

docs/source/workflows/about/rewoo-agent.md (1)

95-95: Documentation update is accurate and consistent.

Line 95 correctly clarifies that tool_names accepts "functions or function groups configured in the YAML file," matching the pattern across all documentation updates in this PR.

examples/advanced_agents/alert_triage_agent/README.md (1)

224-224: Tool_names documentation is clearer with section references.

Line 224 provides a more explicit clarification by specifying "from the functions or function_groups section," which is helpful for users understanding where these tools come from in YAML configuration.

docs/source/workflows/about/tool-calling-agent.md (1)

87-87: Documentation update is consistent across all agents.

Line 87 correctly clarifies that tool_names accepts "functions or function groups configured in the YAML file," maintaining consistency with the ReAct and ReWOO agent documentation updates.

.cursor/rules/nat-agents/general.mdc (2)

1-5: Cursor rule file frontmatter is properly formatted.

The frontmatter includes required fields (description, globs, alwaysApply) and the description properly starts with "Follow these rules when..." as per guidelines. The file maintains proper structure for Cursor rule files.


21-21: ReAct agent guidance consistently updated.

Line 21 correctly clarifies that tool_names should be a "list of YAML-defined functions or function groups," providing users with accurate guidance on supported tool definitions and maintaining consistency with documentation updates across other files.


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@willkill07
Copy link
Member Author

/merge

@rapids-bot rapids-bot bot merged commit 4648f7d into NVIDIA:release/1.3 Oct 23, 2025
17 checks passed
@willkill07 willkill07 deleted the wkk_clarify-tool_names branch October 23, 2025 18:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Improvements or additions to documentation non-breaking Non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants