Skip to content

Commit fd7b557

Browse files
authored
add custom guardrails section at client level (#9)
1 parent 8dd1932 commit fd7b557

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

docs/mcp-scan/guardrails.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,12 +45,15 @@ The configuration file defines guardrailing behavior hierarchically, scoped by *
4545

4646
```yaml
4747
<client-name>:
48+
custom_guardrails:
49+
...
50+
4851
<server-name>:
4952
guardrails:
5053
<default-guardrail-name>: <guardrail-action>
5154
...
5255

53-
custom_guardrails:
56+
custom_guardrails:
5457
- name: <guardrail-name>
5558
id: <guardrail-id>
5659
action: <guardrail-action>
@@ -110,6 +113,9 @@ Custom guardrails allow you to define rules tailored to specific workflows, data
110113
111114
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).
112115
116+
!!! note
117+
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.
118+
113119
### Schema
114120
A custom guardrail is defined using the following fields:
115121

0 commit comments

Comments
 (0)