fix(ENG-12236): document useDefaultToolRules and add ATS/CRM tool rules#10
Merged
Conversation
hiskudin
changed the title
There was a problem hiding this comment.
Pull request overview
Documents the useDefaultToolRules option in @stackone/defender so users understand when built-in per-tool base risk levels and rule behavior apply (and that the default behavior differs unless opted in).
Changes:
- Updated Quick Start and API examples to include
useDefaultToolRules: truewhere per-tool behavior is being demonstrated. - Added clarifying notes that the base risk table and tool-specific rules are opt-in via
useDefaultToolRules. - Updated the Vercel AI SDK example to include
useDefaultToolRules.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
hiskudin
force-pushed
the
fix/document-useDefaultToolRules
branch
from
2d2da5e to
bcf0eda
Compare
hiskudin
changed the title
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
- Document useDefaultToolRules option in Quick Start, API options, Vercel AI SDK example, and Tool-Specific Rules section - Add note that per-tool base risk levels only apply when useDefaultToolRules: true is set - Add sanitization rules for ats_* and crm_* tools (maxFieldLengths, skipFields) — previously they only had risky field overrides - Update README tool table to show actual risky fields for ATS and CRM Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
hiskudin
force-pushed
the
fix/document-useDefaultToolRules
branch
from
bcf0eda to
53764e6
Compare
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
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.
Summary
useDefaultToolRulesoption (default:false) which gates all per-tool risk levels and field rulesuseDefaultToolRules: trueis setWithout this documentation, users would expect
gmail_*to default tohighrisk when it actually defaults tomediumunless opted in.Test plan
useDefaultToolRulesbehavior insrc/core/prompt-defense.ts🤖 Generated with Claude Code
Summary by cubic
Document useDefaultToolRules (default: false) and clarify that per‑tool base risk and field‑handling rules are opt‑in, while risky‑field overrides always apply, addressing ENG‑12236/DEF‑1. Adds ATS (ats_) and CRM (crm_) sanitization rules and updates examples and the README tool table.
Written for commit 53764e6. Summary will update on new commits.