DOCS-395: document AI security features#244
Open
harrison-akeyless wants to merge 20 commits into
Open
Conversation
|
Warning Rate limit exceeded
You’ve run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (8)
📝 WalkthroughWalkthroughThis PR reorganizes AI and MCP documentation from ChangesPre-commit Hook Configuration Updates
AI Security Documentation Expansion and Reorganization
Estimated Code Review Effort🎯 3 (Moderate) | ⏱️ ~25 minutes Suggested Reviewers
Poem
🚥 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 |
Collaborator
Author
|
Before merge, we need to setup redirects. |
- Updated the main MCP Server documentation to provide a clearer overview and usage flow. - Created separate integration pages for Claude Desktop, Cursor, GitHub Copilot, and JetBrains IDEs, detailing configuration and verification steps. - Removed redundant links from the main AI Security index and consolidated MCP references. - Enhanced clarity on requirements and command usage across all MCP-related documentation.
…ation for clarity
…alpha references and enhance clarity
… enhancing command clarity
…MCP and AI documentation
…uctured content and links
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 6
🧹 Nitpick comments (1)
docs/Integrations & Plugins/cli-reference/cli-reference-access-roles.md (1)
69-69: ⚡ Quick winUse consistent official feature naming for ISI.
Consider matching the feature name formatting used elsewhere (“Identity & Secrets Intelligence”) in these two flag descriptions for consistency across docs.
As per coding guidelines, “use official product and feature names with consistent capitalization.”
Also applies to: 294-294
🤖 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/Integrations` & Plugins/cli-reference/cli-reference-access-roles.md at line 69, Update the `--isi-access` flag description to use the official product name "Identity & Secrets Intelligence" (with ampersand and capitalization) instead of "Identity and Secrets Intelligence", and make the identical change for the other occurrence of the same flag description elsewhere in the document so both instances match the official naming; locate the text for the `--isi-access` flag and replace the phrase while keeping the rest of the sentence and supported values (`none`, `scoped`, `all`) unchanged.
🤖 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.
Inline comments:
In `@docs/AI` Security/agentic-runtime-authority.md:
- Line 90: Replace the unexplained acronym "ARA" at its first occurrence by
expanding it to "Agentic Runtime Authority (ARA)" so later uses like
"ARA-enabled secret path" are clear; specifically update the sentence containing
"ARA-enabled secret path" (or the nearest earlier introduction) to read "Agentic
Runtime Authority (ARA)-enabled secret path" or to introduce "Agentic Runtime
Authority (ARA)" immediately before that phrase so subsequent references can use
"ARA."
- Around line 1-7: The page front matter is missing required ReadMe keys; update
the YAML front-matter at the top of the "Agentic Runtime Authority" document to
include an "excerpt" key and complete the "metadata" object with "title" and
"description" (while keeping "robots"), ensuring the front-matter contains:
title, excerpt, deprecated, hidden, and metadata (title, description, robots);
add short, relevant text for "excerpt" and
"metadata.title"/"metadata.description" to satisfy ReadMe requirements.
In `@docs/AI` Security/ai-security.md:
- Line 19: Update the first occurrence of the acronym "LLM" in the table row
containing "Akeyless AI Insights" to expand it on first use as "Large Language
Model (LLM)"; locate the table cell text that currently reads "LLM target setup"
and change it to "Large Language Model (LLM) target setup" so subsequent uses
can keep the acronym.
In `@docs/AI` Security/identity-and-secrets-intelligence.md:
- Around line 44-46: Expand the acronym RBAC at its first mention in the
"Control Access With RBAC" heading or immediately after it by replacing or
augmenting the heading/text to read something like "Control Access With
Role‑Based Access Control (RBAC)" and keep the inline reference to the
`isi-access` administrative rule; ensure the full phrase "Role-Based Access
Control (RBAC)" appears on first use and subsequent mentions may use the
abbreviation RBAC.
In `@docs/AI` Security/MCP/mcp-claude-desktop.md:
- Around line 12-14: Change the first occurrence of the acronym MCP in the
sentence starting "Connect Claude Desktop to the Akeyless MCP Server..." to
spell it out once as "Model Context Protocol (MCP)" so the line reads "Connect
Claude Desktop to the Akeyless Model Context Protocol (MCP) Server..." and leave
subsequent uses as "MCP"; apply the same single-use expansion if MCP appears
earlier elsewhere on the page.
In `@docs/AI` Security/MCP/mcp-jetbrains-ides.md:
- Around line 117-120: The numbered step list starting with "1. In your
JetBrains IDE, go to **Settings → Plugins**." breaks numbering continuity with
the previous section; update the first item in this block (the line that
currently begins "1. In your JetBrains IDE...") to continue the prior sequence
(e.g., change "1." to "3." so the list reads 3–6) or convert these four lines
into a clearly labeled sub-list (e.g., add a subheading like "Install from
disk:" and use 1.–4. under that) so the steps in the sequence are internally
consistent; adjust either the leading numeral on the "In your JetBrains IDE..."
line or introduce the sub-list header accordingly.
---
Nitpick comments:
In `@docs/Integrations` & Plugins/cli-reference/cli-reference-access-roles.md:
- Line 69: Update the `--isi-access` flag description to use the official
product name "Identity & Secrets Intelligence" (with ampersand and
capitalization) instead of "Identity and Secrets Intelligence", and make the
identical change for the other occurrence of the same flag description elsewhere
in the document so both instances match the official naming; locate the text for
the `--isi-access` flag and replace the phrase while keeping the rest of the
sentence and supported values (`none`, `scoped`, `all`) unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: e5c68546-7604-45e6-a4e5-c513b33cc173
📒 Files selected for processing (24)
.pre-commit-config.yamldocs/AI Security/MCP/_order.yamldocs/AI Security/MCP/index.mddocs/AI Security/MCP/mcp-claude-desktop.mddocs/AI Security/MCP/mcp-cursor.mddocs/AI Security/MCP/mcp-github-copilot.mddocs/AI Security/MCP/mcp-jetbrains-ides.mddocs/AI Security/_order.yamldocs/AI Security/agentic-runtime-authority.mddocs/AI Security/ai-security.mddocs/AI Security/akeyless-ai-insight.mddocs/AI Security/identity-and-secrets-intelligence.mddocs/AI Security/prompt-injection-protection-for-ai-agents.mddocs/AI/MCP/_order.yamldocs/AI/MCP/akeyless-mcp-model-context-protocol-command.mddocs/AI/MCP/index.mddocs/AI/agentic-runtime-authority.mddocs/Customer Journeys/customer-journeys/_order.yamldocs/Integrations & Plugins/MCPs.mddocs/Integrations & Plugins/cli-reference/cli-reference-access-roles.mddocs/Integrations & Plugins/cli-reference/index.mddocs/Secure Remote Access/_order.yamldocs/Secure Remote Access/secure-remote-access.mddocs/_order.yaml
💤 Files with no reviewable changes (4)
- docs/AI/MCP/index.md
- docs/AI/MCP/_order.yaml
- docs/AI/agentic-runtime-authority.md
- docs/AI/MCP/akeyless-mcp-model-context-protocol-command.md
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
1 participant
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
Validation
pre-commit run --files ".pre-commit-config.yaml" ".github/lychee/.lycheeignore" "docs/_order.yaml" "docs/AI Security/_order.yaml" "docs/AI Security/index.md" "docs/AI Security/akeyless-ai-insight.md" "docs/AI Security/agentic-runtime-authority.md" "docs/AI Security/identity-and-secrets-intelligence.md" "docs/AI Security/prompt-injection-protection-for-ai-agents.md" "docs/AI Security/MCP/_order.yaml" "docs/AI Security/MCP/index.md" "docs/AI Security/MCP/akeyless-mcp-model-context-protocol-command.md" "docs/AI Security/MCP/akeyless-mcp-plugin-jetbrains-ides.md" "docs/Integrations & Plugins/cli-reference/cli-reference-access-roles.md" "docs/Customer Journeys/customer-journeys/_order.yaml"Summary by CodeRabbit
mcp,mcp-runtime-authority, andruntime-authoritycommands and their parameters.--ara-reports-accessand--isi-access.