Skip to content

DOCS-833: Fix outdated links in AI Security and SRA docs#279

Merged
harrison-akeyless merged 4 commits into
v1.0from
v1.0_docs-833-automation-link-fixes
May 26, 2026
Merged

DOCS-833: Fix outdated links in AI Security and SRA docs#279
harrison-akeyless merged 4 commits into
v1.0from
v1.0_docs-833-automation-link-fixes

Conversation

@harrison-akeyless
Copy link
Copy Markdown
Collaborator

@harrison-akeyless harrison-akeyless commented May 26, 2026

Summary

  • update the MCP docs link in the Agentic Runtime Authority page to the current canonical URL
  • replace outdated SRA Admin Guides links with the current Session Management page URL in the SRA overview page

Validation

  • pre-commit run --files "docs/AI Security/agentic-runtime-authority.md" "docs/Secure Remote Access/secure-remote-access.md"
    • gitleaks: passed
    • markdownlint: passed
    • cspell: passed
    • lychee: passed

Jira

  • DOCS-833

Summary by CodeRabbit

  • Documentation
    • Updated MCP documentation reference link in AI agent setup guide.
    • Added Secure Remote Access admin guide landing page with overview and navigation to key administrative workflows.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 26, 2026

📝 Walkthrough

Walkthrough

This PR updates documentation across two separate areas. It redirects an MCP reference link to current documentation and establishes a navigation hub for SRA administrator guides with entry-point links to session management, resource types, CLI access, file transfer, and SSH certificate workflows.

Changes

Documentation Updates

Layer / File(s) Summary
MCP concepts documentation link update
docs/AI Security/agentic-runtime-authority.md
Hyperlink in the "Set Up The AI Agent" section now points to the general MCP concepts documentation (.../docs/mcp) instead of the older MCP command page.
SRA admin guides landing page
docs/Secure Remote Access/sra-admin-guides/index.md
Entry-point content added with an overview and "Start Here by Admin Objective" section containing five numbered navigation links to admin workflows.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested reviewers

  • EldadH89
  • Avi-Akeyless

Poem

A rabbit hops through docs with glee, 📚
Links refreshed, as they should be,
New guides guide admins on their way,
Clear pathways brighten the day! 🐰✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title accurately describes the main changes: fixing outdated documentation links in both AI Security and SRA docs, which aligns with the primary objectives of updating MCP docs links and replacing outdated SRA Admin Guides links.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch v1.0_docs-833-automation-link-fixes

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@harrison-akeyless harrison-akeyless marked this pull request as ready for review May 26, 2026 17:52
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 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 158: The link text "Akeyless MCP Model Context Protocol Command" does not
match its destination (/docs/mcp); update the anchor text to reflect that it
points to general MCP concepts and docs (for example change "Akeyless MCP Model
Context Protocol Command" to "Akeyless MCP documentation" or "Akeyless MCP
concepts") in the sentence within agentic-runtime-authority.md so the displayed
text and the URL semantics align.
🪄 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: ee124f3f-8d6a-452a-8d5b-57995721bdf9

📥 Commits

Reviewing files that changed from the base of the PR and between 96fca84 and 0d89139.

📒 Files selected for processing (2)
  • docs/AI Security/agentic-runtime-authority.md
  • docs/Secure Remote Access/sra-admin-guides/index.md

## Set Up The AI Agent

To integrate Akeyless with your AI agent, add the **Akeyless MCP server** configuration to the agent’s config file. For general MCP concepts, command syntax, and client setup patterns, see [Akeyless MCP Model Context Protocol Command](https://docs.akeyless.io/docs/akeyless-mcp-model-context-protocol-command). The configuration below is specific to the [mcp-runtime-authority subcommand](https://docs.akeyless.io/docs/cli-reference#mcp-runtime-authority).
To integrate Akeyless with your AI agent, add the **Akeyless MCP server** configuration to the agent’s config file. For general MCP concepts, command syntax, and client setup patterns, see [Akeyless MCP Model Context Protocol Command](https://docs.akeyless.io/docs/mcp). The configuration below is specific to the [mcp-runtime-authority subcommand](https://docs.akeyless.io/docs/cli-reference#mcp-runtime-authority).
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Update link text to match the destination.

The link text "Akeyless MCP Model Context Protocol Command" suggests a specific command reference page, but the URL now points to the general MCP concepts page (/docs/mcp). This creates a mismatch between the link text and destination. Since the sentence says "For general MCP concepts, command syntax, and client setup patterns," the link text should reflect that it's pointing to general documentation.

📝 Suggested revision
-To integrate Akeyless with your AI agent, add the **Akeyless MCP server** configuration to the agent's config file. For general MCP concepts, command syntax, and client setup patterns, see [Akeyless MCP Model Context Protocol Command](https://docs.akeyless.io/docs/mcp). The configuration below is specific to the [mcp-runtime-authority subcommand](https://docs.akeyless.io/docs/cli-reference#mcp-runtime-authority).
+To integrate Akeyless with your AI agent, add the **Akeyless MCP server** configuration to the agent's config file. For general MCP concepts, command syntax, and client setup patterns, see [Akeyless MCP server documentation](https://docs.akeyless.io/docs/mcp). The configuration below is specific to the [mcp-runtime-authority subcommand](https://docs.akeyless.io/docs/cli-reference#mcp-runtime-authority).
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
To integrate Akeyless with your AI agent, add the **Akeyless MCP server** configuration to the agents config file. For general MCP concepts, command syntax, and client setup patterns, see [Akeyless MCP Model Context Protocol Command](https://docs.akeyless.io/docs/mcp). The configuration below is specific to the [mcp-runtime-authority subcommand](https://docs.akeyless.io/docs/cli-reference#mcp-runtime-authority).
To integrate Akeyless with your AI agent, add the **Akeyless MCP server** configuration to the agent's config file. For general MCP concepts, command syntax, and client setup patterns, see [Akeyless MCP server documentation](https://docs.akeyless.io/docs/mcp). The configuration below is specific to the [mcp-runtime-authority subcommand](https://docs.akeyless.io/docs/cli-reference#mcp-runtime-authority).
🤖 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/AI` Security/agentic-runtime-authority.md at line 158, The link text
"Akeyless MCP Model Context Protocol Command" does not match its destination
(/docs/mcp); update the anchor text to reflect that it points to general MCP
concepts and docs (for example change "Akeyless MCP Model Context Protocol
Command" to "Akeyless MCP documentation" or "Akeyless MCP concepts") in the
sentence within agentic-runtime-authority.md so the displayed text and the URL
semantics align.

@harrison-akeyless harrison-akeyless merged commit 76bf7a4 into v1.0 May 26, 2026
14 checks passed
@harrison-akeyless harrison-akeyless deleted the v1.0_docs-833-automation-link-fixes branch May 26, 2026 18:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant