You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Adds a new documentation guide for production tool runtime safety and validation in Swarms. The guide covers narrow tool contracts, validation before side effects, secret handling, structured outputs, dry-run behavior for destructive actions, audit-friendly logs, and a reviewer checklist.
Why this helps
Tool safety is a recurring concern for agent systems because tools often bridge model output with files, APIs, tickets, payments, or databases. This guide gives contributors and users a practical checklist plus copyable Python examples that fit the existing Tools Reference section.
Bounty eligibility
This PR is intended as a bounty-eligible documentation contribution under the Swarms Documentation Bounty Initiative.
Expected tier: Gold documentation contribution ($20-$50), because it adds a new major guide over 500 words with examples and a review checklist.
Validation
Added the guide to docs/swarms/tools/tool_runtime_safety.md
Added the page to docs/mkdocs.yml under Tools Reference
Confirmed the new guide is 1,100+ words
Ran git diff --check
Attempted mkdocs build --strict, but this local machine does not have mkdocs installed
I do not have permission to apply repository labels from this fork, but this PR is submitted for the documentation bounty program. Could a maintainer please add the bounty-eligible label if this contribution qualifies?
Closing — both files this touches no longer exist.
docs/mkdocs.yml and the new docs/swarms/tools/tool_runtime_safety.md are both under docs/, which was removed from the repository in 8bd8d227 (2026-07-27). Nothing left to rebase onto.
Tool runtime safety is a real topic — see #1930, which is hardening the actual run_bash tool against argv-level bypasses. If you want to document that behavior once it lands, that would be useful.
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
documentationImprovements or additions to documentation
2 participants
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.
Summary
Adds a new documentation guide for production tool runtime safety and validation in Swarms. The guide covers narrow tool contracts, validation before side effects, secret handling, structured outputs, dry-run behavior for destructive actions, audit-friendly logs, and a reviewer checklist.
Why this helps
Tool safety is a recurring concern for agent systems because tools often bridge model output with files, APIs, tickets, payments, or databases. This guide gives contributors and users a practical checklist plus copyable Python examples that fit the existing Tools Reference section.
Bounty eligibility
This PR is intended as a
bounty-eligibledocumentation contribution under the Swarms Documentation Bounty Initiative.Expected tier: Gold documentation contribution ($20-$50), because it adds a new major guide over 500 words with examples and a review checklist.
Validation
docs/swarms/tools/tool_runtime_safety.mddocs/mkdocs.ymlunder Tools Referencegit diff --checkmkdocs build --strict, but this local machine does not havemkdocsinstalled📚 Documentation preview 📚: https://swarms--1595.org.readthedocs.build/en/1595/