docs: add Vaultak runtime security integration for CrewAI agents#5973
docs: add Vaultak runtime security integration for CrewAI agents#5973samueloladji-beep wants to merge 3 commits into
Conversation
Adds docs/en/observability/vaultak.mdx — a step-by-step guide for attaching VaultakCallbackHandler (pip install langchain-vaultak) to CrewAI agents via the LLM callbacks parameter. Covers configuration, a full crew example, monitored-event table, and links. Also adds a "Runtime Security" section card to overview.mdx and registers en/observability/vaultak in docs.json across all language and version entries. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughAdds Vaultak runtime security docs: a Runtime Security card on the observability overview linking to a new Vaultak Integration page that documents installation, handler usage with a Python example, configuration options, monitored events, and reference links. ChangesVaultak Runtime Security Integration Documentation
🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
There was a problem hiding this comment.
🧹 Nitpick comments (2)
docs/en/observability/vaultak.mdx (2)
112-121: 💤 Low valueConsider demonstrating the
verboseparameter in the code example.The configuration table documents five parameters including
verbose, but the code example (lines 56-61) only demonstrates four. While not incorrect, addingverbose=Trueto the example would make the documentation more comprehensive.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/en/observability/vaultak.mdx` around lines 112 - 121, Update the example configuration block to include the verbose parameter so readers see how to enable verbose logging; specifically add verbose=True alongside the existing parameters (e.g., where the example constructs the Vaultak client/config with api_key and agent_name) so the code snippet demonstrates all five documented options including verbose.
1-6: ⚡ Quick winIcon mismatch between overview card and page frontmatter.
The overview page uses
icon="shield-halved"for the Vaultak card (line 66 in overview.mdx), but this page's frontmatter specifiesicon="shield-check". For consistency, both should use the same icon.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/en/observability/vaultak.mdx` around lines 1 - 6, The frontmatter for the Vaultak Integration page currently sets icon="shield-check" while the overview card uses icon="shield-halved"; update one of them so both use the same icon string (e.g., change the frontmatter icon="shield-check" to icon="shield-halved" or vice versa) to ensure consistent icons across the overview card and the Vaultak page.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@docs/en/observability/vaultak.mdx`:
- Around line 112-121: Update the example configuration block to include the
verbose parameter so readers see how to enable verbose logging; specifically add
verbose=True alongside the existing parameters (e.g., where the example
constructs the Vaultak client/config with api_key and agent_name) so the code
snippet demonstrates all five documented options including verbose.
- Around line 1-6: The frontmatter for the Vaultak Integration page currently
sets icon="shield-check" while the overview card uses icon="shield-halved";
update one of them so both use the same icon string (e.g., change the
frontmatter icon="shield-check" to icon="shield-halved" or vice versa) to ensure
consistent icons across the overview card and the Vaultak page.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 6e0fc09f-82cf-4f3d-8d68-6b49f1224318
📒 Files selected for processing (3)
docs/docs.jsondocs/en/observability/overview.mdxdocs/en/observability/vaultak.mdx
- Change icon from shield-check to shield-halved in frontmatter - Add verbose=True to the stricter-threshold config example Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Addresses CodeRabbit nitpick: the configuration table documents verbose but the quick-start example omitted it. Added verbose=True to the main VaultakCallbackHandler instantiation so all five documented params are demonstrated. (Icon was already shield-halved in both frontmatter and overview card — no change needed there.) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
@joaomdmoura @bhancockio — ready for review. This adds a Vaultak runtime security integration guide to the CrewAI observability docs. |
|
Hey @lorenzejay, all CI checks are passing — would appreciate a review when you get a chance. Thanks! |
Summary
Adds a new observability page for Vaultak — a runtime security platform that wraps CrewAI agents with real-time protection.
docs/en/observability/vaultak.mdx— step-by-step integration guide covering:docs/en/observability/overview.mdx— adds a new "Runtime Security"<CardGroup>section with a Vaultak carddocs/docs.json— registersen/observability/vaultakin the Observability nav group across all language/version entriesInstall
Quick preview
Test plan
/en/observability/vaultak🤖 Generated with Claude Code
Summary by CodeRabbit