docs: add tools integration guide #1414
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add a comprehensive "Tools Integration" guide to the advanced user documentation. The new guide covers supported tools, configuration settings (including passthrough mode), implementation examples, and security considerations for tool usage in NeMo Guardrails. Also update the advanced index to include the new guide.
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation for tools integration with NeMo Guardrails, providing detailed guidance on implementing external tools while maintaining security controls. The guide covers configuration best practices, implementation examples, and important security considerations for safe tool usage.
- Added complete tools integration guide covering LangChain tools support and custom tool creation
- Provided configuration examples with passthrough mode settings for input/output rails
- Included security considerations highlighting tool message risks and recommended safety measures
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/user-guides/advanced/tools-integration.md | New comprehensive guide for tools integration with configuration examples, implementation patterns, and security best practices |
| docs/user-guides/advanced/index.rst | Updated advanced documentation index to include the new tools integration guide |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Contributor
Documentation preview |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
miyoungc
reviewed
Sep 24, 2025
miyoungc
reviewed
Sep 26, 2025
miyoungc
reviewed
Sep 26, 2025
miyoungc
reviewed
Sep 26, 2025
Signed-off-by: Miyoung Choi <[email protected]>
Signed-off-by: Miyoung Choi <[email protected]>
Signed-off-by: Miyoung Choi <[email protected]>
miyoungc
reviewed
Sep 26, 2025
Signed-off-by: Miyoung Choi <[email protected]>
Signed-off-by: Miyoung Choi <[email protected]>
Signed-off-by: Miyoung Choi <[email protected]>
miyoungc
approved these changes
Sep 26, 2025
Pouyanpi
added a commit
that referenced
this pull request
Sep 29, 2025
* docs: add tools integration guide Add a comprehensive "Tools Integration" guide to the advanced user documentation. The new guide covers supported tools, configuration settings (including passthrough mode), implementation examples, and security considerations for tool usage in NeMo Guardrails. Also update the advanced index to include the new guide. * add the new page to the right index file (#1415) * Update docs/user-guides/advanced/tools-integration.md Signed-off-by: Miyoung Choi <[email protected]> * Update docs/user-guides/advanced/tools-integration.md Signed-off-by: Miyoung Choi <[email protected]> * Update docs/user-guides/advanced/tools-integration.md Signed-off-by: Miyoung Choi <[email protected]> * Update docs/user-guides/advanced/tools-integration.md Signed-off-by: Miyoung Choi <[email protected]> * Update docs/user-guides/advanced/tools-integration.md Signed-off-by: Miyoung Choi <[email protected]> * Update docs/user-guides/advanced/tools-integration.md Signed-off-by: Miyoung Choi <[email protected]> --------- Signed-off-by: Miyoung Choi <[email protected]> Co-authored-by: Miyoung Choi <[email protected]>
Pouyanpi
added a commit
that referenced
this pull request
Oct 1, 2025
* docs: add tools integration guide Add a comprehensive "Tools Integration" guide to the advanced user documentation. The new guide covers supported tools, configuration settings (including passthrough mode), implementation examples, and security considerations for tool usage in NeMo Guardrails. Also update the advanced index to include the new guide. * add the new page to the right index file (#1415) * Update docs/user-guides/advanced/tools-integration.md Signed-off-by: Miyoung Choi <[email protected]> * Update docs/user-guides/advanced/tools-integration.md Signed-off-by: Miyoung Choi <[email protected]> * Update docs/user-guides/advanced/tools-integration.md Signed-off-by: Miyoung Choi <[email protected]> * Update docs/user-guides/advanced/tools-integration.md Signed-off-by: Miyoung Choi <[email protected]> * Update docs/user-guides/advanced/tools-integration.md Signed-off-by: Miyoung Choi <[email protected]> * Update docs/user-guides/advanced/tools-integration.md Signed-off-by: Miyoung Choi <[email protected]> --------- Signed-off-by: Miyoung Choi <[email protected]> Co-authored-by: Miyoung Choi <[email protected]>
tgasser-nv
pushed a commit
that referenced
this pull request
Oct 14, 2025
* docs: add tools integration guide Add a comprehensive "Tools Integration" guide to the advanced user documentation. The new guide covers supported tools, configuration settings (including passthrough mode), implementation examples, and security considerations for tool usage in NeMo Guardrails. Also update the advanced index to include the new guide. * add the new page to the right index file (#1415) * Update docs/user-guides/advanced/tools-integration.md Signed-off-by: Miyoung Choi <[email protected]> * Update docs/user-guides/advanced/tools-integration.md Signed-off-by: Miyoung Choi <[email protected]> * Update docs/user-guides/advanced/tools-integration.md Signed-off-by: Miyoung Choi <[email protected]> * Update docs/user-guides/advanced/tools-integration.md Signed-off-by: Miyoung Choi <[email protected]> * Update docs/user-guides/advanced/tools-integration.md Signed-off-by: Miyoung Choi <[email protected]> * Update docs/user-guides/advanced/tools-integration.md Signed-off-by: Miyoung Choi <[email protected]> --------- Signed-off-by: Miyoung Choi <[email protected]> Co-authored-by: Miyoung Choi <[email protected]>
tgasser-nv
pushed a commit
that referenced
this pull request
Oct 14, 2025
* docs: add tools integration guide Add a comprehensive "Tools Integration" guide to the advanced user documentation. The new guide covers supported tools, configuration settings (including passthrough mode), implementation examples, and security considerations for tool usage in NeMo Guardrails. Also update the advanced index to include the new guide. * add the new page to the right index file (#1415) * Update docs/user-guides/advanced/tools-integration.md Signed-off-by: Miyoung Choi <[email protected]> * Update docs/user-guides/advanced/tools-integration.md Signed-off-by: Miyoung Choi <[email protected]> * Update docs/user-guides/advanced/tools-integration.md Signed-off-by: Miyoung Choi <[email protected]> * Update docs/user-guides/advanced/tools-integration.md Signed-off-by: Miyoung Choi <[email protected]> * Update docs/user-guides/advanced/tools-integration.md Signed-off-by: Miyoung Choi <[email protected]> * Update docs/user-guides/advanced/tools-integration.md Signed-off-by: Miyoung Choi <[email protected]> --------- Signed-off-by: Miyoung Choi <[email protected]> Co-authored-by: Miyoung Choi <[email protected]>
tgasser-nv
pushed a commit
that referenced
this pull request
Oct 14, 2025
* docs: add tools integration guide Add a comprehensive "Tools Integration" guide to the advanced user documentation. The new guide covers supported tools, configuration settings (including passthrough mode), implementation examples, and security considerations for tool usage in NeMo Guardrails. Also update the advanced index to include the new guide. * add the new page to the right index file (#1415) * Update docs/user-guides/advanced/tools-integration.md Signed-off-by: Miyoung Choi <[email protected]> * Update docs/user-guides/advanced/tools-integration.md Signed-off-by: Miyoung Choi <[email protected]> * Update docs/user-guides/advanced/tools-integration.md Signed-off-by: Miyoung Choi <[email protected]> * Update docs/user-guides/advanced/tools-integration.md Signed-off-by: Miyoung Choi <[email protected]> * Update docs/user-guides/advanced/tools-integration.md Signed-off-by: Miyoung Choi <[email protected]> * Update docs/user-guides/advanced/tools-integration.md Signed-off-by: Miyoung Choi <[email protected]> --------- Signed-off-by: Miyoung Choi <[email protected]> Co-authored-by: Miyoung Choi <[email protected]>
tgasser-nv
pushed a commit
that referenced
this pull request
Oct 28, 2025
* docs: add tools integration guide Add a comprehensive "Tools Integration" guide to the advanced user documentation. The new guide covers supported tools, configuration settings (including passthrough mode), implementation examples, and security considerations for tool usage in NeMo Guardrails. Also update the advanced index to include the new guide. * add the new page to the right index file (#1415) * Update docs/user-guides/advanced/tools-integration.md Signed-off-by: Miyoung Choi <[email protected]> * Update docs/user-guides/advanced/tools-integration.md Signed-off-by: Miyoung Choi <[email protected]> * Update docs/user-guides/advanced/tools-integration.md Signed-off-by: Miyoung Choi <[email protected]> * Update docs/user-guides/advanced/tools-integration.md Signed-off-by: Miyoung Choi <[email protected]> * Update docs/user-guides/advanced/tools-integration.md Signed-off-by: Miyoung Choi <[email protected]> * Update docs/user-guides/advanced/tools-integration.md Signed-off-by: Miyoung Choi <[email protected]> --------- Signed-off-by: Miyoung Choi <[email protected]> Co-authored-by: Miyoung Choi <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add "Tools Integration" guide to the advanced user documentation. The new guide covers supported tools, configuration settings (including passthrough mode), implementation examples, and security considerations for tool usage in NeMo Guardrails. Also update the advanced index to include the new guide.