Skip to content

docs: adds a subsection for mcp guardrails - #5869

Merged
akshaydeo merged 1 commit into
devfrom
08-05-docs_adds_a_subsection_for_mcp_guardrails
Aug 5, 2026
Merged

docs: adds a subsection for mcp guardrails#5869
akshaydeo merged 1 commit into
devfrom
08-05-docs_adds_a_subsection_for_mcp_guardrails

Conversation

@Madhuvod

@Madhuvod Madhuvod commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds a dedicated MCP Guardrails section to the guardrails documentation, explaining how guardrails apply at the tool-execution boundary for MCP targets, including phase behavior, UI field descriptions, and provider compatibility notes.

Changes

  • Replaced the brief inline mention of MCP rule behavior in the Architecture section with a cross-reference link to the new dedicated section.
  • Added a new ## MCP Guardrails section covering:
    • How input, output, and both phases apply at the tool-execution boundary.
    • A table describing the flow and block behavior for each phase.
    • Guidance on selecting MCP clients, tools, and tool arguments when creating rules.
    • A note clarifying that all supported guardrail providers work with MCP rules and that redaction support follows the same provider constraints as LLM rules.
    • Cross-references to existing sections for rule configuration and CEL expression examples.
  • Added a screenshot (ui-mcp-guardrail-rule.png) showing the MCP guardrail rule editor in the UI.

Type of change

  • Bug fix
  • Feature
  • Refactor
  • Documentation
  • Chore/CI

Affected areas

  • Core (Go)
  • Transports (HTTP)
  • Providers/Integrations
  • Plugins
  • UI (React)
  • Docs

How to test

Navigate to the rendered guardrails documentation page and verify:

  • The Architecture section links to #mcp-guardrails instead of containing inline MCP text.
  • The new MCP Guardrails section renders correctly with the phase table, screenshot, and note.
  • The screenshot image loads without errors.

Screenshots/Recordings

The new section includes a screenshot of the MCP guardrail rule editor (ui-mcp-guardrail-rule.png).

Breaking changes

  • Yes
  • No

Related issues

Security considerations

None. Documentation-only change.

Checklist

  • I read docs/contributing/README.md and followed the guidelines
  • I added/updated tests where appropriate
  • I updated documentation where needed
  • I verified builds succeed (Go and UI)
  • I verified the CI pipeline passes locally if applicable

@coderabbitai

coderabbitai Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Added comprehensive documentation for MCP Guardrails.
    • Explained execution-boundary protection, input/output phases, blocking and redaction behavior.
    • Documented UI targeting, shared provider support, and reusable profiles, sampling, and timeout settings.
    • Updated architecture guidance to link to the new MCP Guardrails section.

Walkthrough

This PR updates docs/enterprise/guardrails.mdx. It replaces an inline architecture note with a reference to a new MCP Guardrails section. The new section documents inspection phases, block and redact behavior, UI targeting fields, provider support, and reused settings.

Changes

MCP guardrails documentation

Layer / File(s) Summary
MCP guardrails section
docs/enterprise/guardrails.mdx
The architecture text now points to a dedicated MCP Guardrails section. That section documents pre-execution, post-execution, and combined inspection behavior, blocking and redaction outcomes, UI targeting fields, provider compatibility, and reuse of existing guardrail settings.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

  • maximhq/bifrost#5758: This PR expands the MCP guardrail behavior and concepts documented there.
  • maximhq/bifrost#5520: Both PRs modify docs/enterprise/guardrails.mdx with related guardrail documentation updates.

Suggested reviewers: akshaydeo, bearts

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (2 warnings)

Check name Status Explanation Resolution
Linked Issues check ⚠️ Warning The PR adds MCP guardrails documentation but does not address linked issue #123 requirements for provider File API support. Implement or link changes that support file uploads through provider File APIs, including the required endpoint and related workflows.
Out of Scope Changes check ⚠️ Warning The MCP guardrails documentation changes are unrelated to linked issue #123, which concerns File API support for providers. Link this PR to an MCP guardrails documentation issue, or revise the changes to address the File API Support objectives in issue #123.
✅ Passed checks (3 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check ✅ Passed The title clearly identifies the main documentation change: adding an MCP Guardrails subsection.
Description check ✅ Passed The description covers the purpose, changes, testing steps, affected areas, screenshots, breaking changes, security, and checklist.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch 08-05-docs_adds_a_subsection_for_mcp_guardrails

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

Madhuvod commented Aug 5, 2026

Copy link
Copy Markdown
Contributor Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

@Madhuvod
Madhuvod marked this pull request as ready for review August 5, 2026 15:45
@coderabbitai
coderabbitai Bot requested review from BearTS and akshaydeo August 5, 2026 15:46

akshaydeo commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Merge activity

  • Aug 5, 6:14 PM UTC: A user started a stack merge that includes this pull request via Graphite.
  • Aug 5, 6:15 PM UTC: @akshaydeo merged this pull request with Graphite.

@akshaydeo
akshaydeo merged commit 5453ef2 into dev Aug 5, 2026
15 checks passed
@akshaydeo
akshaydeo deleted the 08-05-docs_adds_a_subsection_for_mcp_guardrails branch August 5, 2026 18:15
akshaydeo pushed a commit that referenced this pull request Aug 7, 2026
Adds a dedicated **MCP Guardrails** section to the guardrails documentation, explaining how guardrails apply at the tool-execution boundary for MCP targets, including phase behavior, UI field descriptions, and provider compatibility notes.

- Replaced the brief inline mention of MCP rule behavior in the Architecture section with a cross-reference link to the new dedicated section.
- Added a new `## MCP Guardrails` section covering:
  - How `input`, `output`, and `both` phases apply at the tool-execution boundary.
  - A table describing the flow and block behavior for each phase.
  - Guidance on selecting MCP clients, tools, and tool arguments when creating rules.
  - A note clarifying that all supported guardrail providers work with MCP rules and that redaction support follows the same provider constraints as LLM rules.
  - Cross-references to existing sections for rule configuration and CEL expression examples.
- Added a screenshot (`ui-mcp-guardrail-rule.png`) showing the MCP guardrail rule editor in the UI.

- [ ] Bug fix
- [ ] Feature
- [ ] Refactor
- [x] Documentation
- [ ] Chore/CI

- [ ] Core (Go)
- [ ] Transports (HTTP)
- [ ] Providers/Integrations
- [ ] Plugins
- [ ] UI (React)
- [x] Docs

Navigate to the rendered guardrails documentation page and verify:
- The Architecture section links to `#mcp-guardrails` instead of containing inline MCP text.
- The new MCP Guardrails section renders correctly with the phase table, screenshot, and note.
- The screenshot image loads without errors.

The new section includes a screenshot of the MCP guardrail rule editor (`ui-mcp-guardrail-rule.png`).

- [ ] Yes
- [x] No

None. Documentation-only change.

- [ ] I read `docs/contributing/README.md` and followed the guidelines
- [ ] I added/updated tests where appropriate
- [x] I updated documentation where needed
- [ ] I verified builds succeed (Go and UI)
- [ ] I verified the CI pipeline passes locally if applicable
akshaydeo pushed a commit that referenced this pull request Aug 10, 2026
## Summary

Adds a dedicated **MCP Guardrails** section to the guardrails documentation, explaining how guardrails apply at the tool-execution boundary for MCP targets, including phase behavior, UI field descriptions, and provider compatibility notes.

## Changes

- Replaced the brief inline mention of MCP rule behavior in the Architecture section with a cross-reference link to the new dedicated section.
- Added a new `## MCP Guardrails` section covering:
  - How `input`, `output`, and `both` phases apply at the tool-execution boundary.
  - A table describing the flow and block behavior for each phase.
  - Guidance on selecting MCP clients, tools, and tool arguments when creating rules.
  - A note clarifying that all supported guardrail providers work with MCP rules and that redaction support follows the same provider constraints as LLM rules.
  - Cross-references to existing sections for rule configuration and CEL expression examples.
- Added a screenshot (`ui-mcp-guardrail-rule.png`) showing the MCP guardrail rule editor in the UI.

## Type of change

- [ ] Bug fix
- [ ] Feature
- [ ] Refactor
- [x] Documentation
- [ ] Chore/CI

## Affected areas

- [ ] Core (Go)
- [ ] Transports (HTTP)
- [ ] Providers/Integrations
- [ ] Plugins
- [ ] UI (React)
- [x] Docs

## How to test

Navigate to the rendered guardrails documentation page and verify:
- The Architecture section links to `#mcp-guardrails` instead of containing inline MCP text.
- The new MCP Guardrails section renders correctly with the phase table, screenshot, and note.
- The screenshot image loads without errors.

## Screenshots/Recordings

The new section includes a screenshot of the MCP guardrail rule editor (`ui-mcp-guardrail-rule.png`).

## Breaking changes

- [ ] Yes
- [x] No

## Related issues

## Security considerations

None. Documentation-only change.

## Checklist

- [ ] I read `docs/contributing/README.md` and followed the guidelines
- [ ] I added/updated tests where appropriate
- [x] I updated documentation where needed
- [ ] I verified builds succeed (Go and UI)
- [ ] I verified the CI pipeline passes locally if applicable
atharvamhaske pushed a commit to atharvamhaske/bifrost that referenced this pull request Aug 13, 2026
Adds a dedicated **MCP Guardrails** section to the guardrails documentation, explaining how guardrails apply at the tool-execution boundary for MCP targets, including phase behavior, UI field descriptions, and provider compatibility notes.

- Replaced the brief inline mention of MCP rule behavior in the Architecture section with a cross-reference link to the new dedicated section.
- Added a new `## MCP Guardrails` section covering:
  - How `input`, `output`, and `both` phases apply at the tool-execution boundary.
  - A table describing the flow and block behavior for each phase.
  - Guidance on selecting MCP clients, tools, and tool arguments when creating rules.
  - A note clarifying that all supported guardrail providers work with MCP rules and that redaction support follows the same provider constraints as LLM rules.
  - Cross-references to existing sections for rule configuration and CEL expression examples.
- Added a screenshot (`ui-mcp-guardrail-rule.png`) showing the MCP guardrail rule editor in the UI.

- [ ] Bug fix
- [ ] Feature
- [ ] Refactor
- [x] Documentation
- [ ] Chore/CI

- [ ] Core (Go)
- [ ] Transports (HTTP)
- [ ] Providers/Integrations
- [ ] Plugins
- [ ] UI (React)
- [x] Docs

Navigate to the rendered guardrails documentation page and verify:
- The Architecture section links to `#mcp-guardrails` instead of containing inline MCP text.
- The new MCP Guardrails section renders correctly with the phase table, screenshot, and note.
- The screenshot image loads without errors.

The new section includes a screenshot of the MCP guardrail rule editor (`ui-mcp-guardrail-rule.png`).

- [ ] Yes
- [x] No

None. Documentation-only change.

- [ ] I read `docs/contributing/README.md` and followed the guidelines
- [ ] I added/updated tests where appropriate
- [x] I updated documentation where needed
- [ ] I verified builds succeed (Go and UI)
- [ ] I verified the CI pipeline passes locally if applicable
akshaydeo pushed a commit that referenced this pull request Aug 13, 2026
## Summary

Adds a dedicated **MCP Guardrails** section to the guardrails documentation, explaining how guardrails apply at the tool-execution boundary for MCP targets, including phase behavior, UI field descriptions, and provider compatibility notes.

## Changes

- Replaced the brief inline mention of MCP rule behavior in the Architecture section with a cross-reference link to the new dedicated section.
- Added a new `## MCP Guardrails` section covering:
  - How `input`, `output`, and `both` phases apply at the tool-execution boundary.
  - A table describing the flow and block behavior for each phase.
  - Guidance on selecting MCP clients, tools, and tool arguments when creating rules.
  - A note clarifying that all supported guardrail providers work with MCP rules and that redaction support follows the same provider constraints as LLM rules.
  - Cross-references to existing sections for rule configuration and CEL expression examples.
- Added a screenshot (`ui-mcp-guardrail-rule.png`) showing the MCP guardrail rule editor in the UI.

## Type of change

- [ ] Bug fix
- [ ] Feature
- [ ] Refactor
- [x] Documentation
- [ ] Chore/CI

## Affected areas

- [ ] Core (Go)
- [ ] Transports (HTTP)
- [ ] Providers/Integrations
- [ ] Plugins
- [ ] UI (React)
- [x] Docs

## How to test

Navigate to the rendered guardrails documentation page and verify:
- The Architecture section links to `#mcp-guardrails` instead of containing inline MCP text.
- The new MCP Guardrails section renders correctly with the phase table, screenshot, and note.
- The screenshot image loads without errors.

## Screenshots/Recordings

The new section includes a screenshot of the MCP guardrail rule editor (`ui-mcp-guardrail-rule.png`).

## Breaking changes

- [ ] Yes
- [x] No

## Related issues

## Security considerations

None. Documentation-only change.

## Checklist

- [ ] I read `docs/contributing/README.md` and followed the guidelines
- [ ] I added/updated tests where appropriate
- [x] I updated documentation where needed
- [ ] I verified builds succeed (Go and UI)
- [ ] I verified the CI pipeline passes locally if applicable
akshaydeo pushed a commit that referenced this pull request Aug 13, 2026
## Summary

Adds a dedicated **MCP Guardrails** section to the guardrails documentation, explaining how guardrails apply at the tool-execution boundary for MCP targets, including phase behavior, UI field descriptions, and provider compatibility notes.

## Changes

- Replaced the brief inline mention of MCP rule behavior in the Architecture section with a cross-reference link to the new dedicated section.
- Added a new `## MCP Guardrails` section covering:
  - How `input`, `output`, and `both` phases apply at the tool-execution boundary.
  - A table describing the flow and block behavior for each phase.
  - Guidance on selecting MCP clients, tools, and tool arguments when creating rules.
  - A note clarifying that all supported guardrail providers work with MCP rules and that redaction support follows the same provider constraints as LLM rules.
  - Cross-references to existing sections for rule configuration and CEL expression examples.
- Added a screenshot (`ui-mcp-guardrail-rule.png`) showing the MCP guardrail rule editor in the UI.

## Type of change

- [ ] Bug fix
- [ ] Feature
- [ ] Refactor
- [x] Documentation
- [ ] Chore/CI

## Affected areas

- [ ] Core (Go)
- [ ] Transports (HTTP)
- [ ] Providers/Integrations
- [ ] Plugins
- [ ] UI (React)
- [x] Docs

## How to test

Navigate to the rendered guardrails documentation page and verify:
- The Architecture section links to `#mcp-guardrails` instead of containing inline MCP text.
- The new MCP Guardrails section renders correctly with the phase table, screenshot, and note.
- The screenshot image loads without errors.

## Screenshots/Recordings

The new section includes a screenshot of the MCP guardrail rule editor (`ui-mcp-guardrail-rule.png`).

## Breaking changes

- [ ] Yes
- [x] No

## Related issues

## Security considerations

None. Documentation-only change.

## Checklist

- [ ] I read `docs/contributing/README.md` and followed the guidelines
- [ ] I added/updated tests where appropriate
- [x] I updated documentation where needed
- [ ] I verified builds succeed (Go and UI)
- [ ] I verified the CI pipeline passes locally if applicable
akshaydeo pushed a commit that referenced this pull request Aug 14, 2026
## Summary

Adds a dedicated **MCP Guardrails** section to the guardrails documentation, explaining how guardrails apply at the tool-execution boundary for MCP targets, including phase behavior, UI field descriptions, and provider compatibility notes.

## Changes

- Replaced the brief inline mention of MCP rule behavior in the Architecture section with a cross-reference link to the new dedicated section.
- Added a new `## MCP Guardrails` section covering:
  - How `input`, `output`, and `both` phases apply at the tool-execution boundary.
  - A table describing the flow and block behavior for each phase.
  - Guidance on selecting MCP clients, tools, and tool arguments when creating rules.
  - A note clarifying that all supported guardrail providers work with MCP rules and that redaction support follows the same provider constraints as LLM rules.
  - Cross-references to existing sections for rule configuration and CEL expression examples.
- Added a screenshot (`ui-mcp-guardrail-rule.png`) showing the MCP guardrail rule editor in the UI.

## Type of change

- [ ] Bug fix
- [ ] Feature
- [ ] Refactor
- [x] Documentation
- [ ] Chore/CI

## Affected areas

- [ ] Core (Go)
- [ ] Transports (HTTP)
- [ ] Providers/Integrations
- [ ] Plugins
- [ ] UI (React)
- [x] Docs

## How to test

Navigate to the rendered guardrails documentation page and verify:
- The Architecture section links to `#mcp-guardrails` instead of containing inline MCP text.
- The new MCP Guardrails section renders correctly with the phase table, screenshot, and note.
- The screenshot image loads without errors.

## Screenshots/Recordings

The new section includes a screenshot of the MCP guardrail rule editor (`ui-mcp-guardrail-rule.png`).

## Breaking changes

- [ ] Yes
- [x] No

## Related issues

## Security considerations

None. Documentation-only change.

## Checklist

- [ ] I read `docs/contributing/README.md` and followed the guidelines
- [ ] I added/updated tests where appropriate
- [x] I updated documentation where needed
- [ ] I verified builds succeed (Go and UI)
- [ ] I verified the CI pipeline passes locally if applicable
akshaydeo pushed a commit that referenced this pull request Aug 19, 2026
## Summary

Adds a dedicated **MCP Guardrails** section to the guardrails documentation, explaining how guardrails apply at the tool-execution boundary for MCP targets, including phase behavior, UI field descriptions, and provider compatibility notes.

## Changes

- Replaced the brief inline mention of MCP rule behavior in the Architecture section with a cross-reference link to the new dedicated section.
- Added a new `## MCP Guardrails` section covering:
  - How `input`, `output`, and `both` phases apply at the tool-execution boundary.
  - A table describing the flow and block behavior for each phase.
  - Guidance on selecting MCP clients, tools, and tool arguments when creating rules.
  - A note clarifying that all supported guardrail providers work with MCP rules and that redaction support follows the same provider constraints as LLM rules.
  - Cross-references to existing sections for rule configuration and CEL expression examples.
- Added a screenshot (`ui-mcp-guardrail-rule.png`) showing the MCP guardrail rule editor in the UI.

## Type of change

- [ ] Bug fix
- [ ] Feature
- [ ] Refactor
- [x] Documentation
- [ ] Chore/CI

## Affected areas

- [ ] Core (Go)
- [ ] Transports (HTTP)
- [ ] Providers/Integrations
- [ ] Plugins
- [ ] UI (React)
- [x] Docs

## How to test

Navigate to the rendered guardrails documentation page and verify:
- The Architecture section links to `#mcp-guardrails` instead of containing inline MCP text.
- The new MCP Guardrails section renders correctly with the phase table, screenshot, and note.
- The screenshot image loads without errors.

## Screenshots/Recordings

The new section includes a screenshot of the MCP guardrail rule editor (`ui-mcp-guardrail-rule.png`).

## Breaking changes

- [ ] Yes
- [x] No

## Related issues

## Security considerations

None. Documentation-only change.

## Checklist

- [ ] I read `docs/contributing/README.md` and followed the guidelines
- [ ] I added/updated tests where appropriate
- [x] I updated documentation where needed
- [ ] I verified builds succeed (Go and UI)
- [ ] I verified the CI pipeline passes locally if applicable
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.

2 participants