Skip to content

add custom guardrails section to client level #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

add custom guardrails section to client level #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/mcp-scan/guardrails.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,15 @@ The configuration file defines guardrailing behavior hierarchically, scoped by *

```yaml
<client-name>:
custom_guardrails:
...

<server-name>:
guardrails:
<default-guardrail-name>: <guardrail-action>
...

custom_guardrails:
custom_guardrails:
- name: <guardrail-name>
id: <guardrail-id>
action: <guardrail-action>
Expand Down Expand Up @@ -107,6 +110,9 @@ Custom guardrails allow you to define rules tailored to specific workflows, data

To get started writing custom rules, refer to the [rule writing reference](./rules.md) to get started quickly with writing guardrails, or explore the rest of this documentation to learn about the concepts in depth, perhaps [starting with this introduction](./index.md).

!!! note
You can add `custom_guardrails` on either a per-client or a per-server level. If you add it at the client level, the guardrail will be enforced on all servers used by that client.

### Schema
A custom guardrail is defined using the following fields:

Expand Down