Skip to content

Commit cbffc55

Browse files
scaffolding
1 parent f7edda8 commit cbffc55

File tree

15 files changed

+157
-38
lines changed

15 files changed

+157
-38
lines changed

docs/assets/invariant.css

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -220,21 +220,18 @@ strong {
220220

221221
blockquote {
222222
background-color: #fdfdfd;
223-
border-left: 0.5pt solid #3E3AFF !important;
223+
border-left: 2pt solid #3E3AFF !important;
224224
border-radius: 5pt;
225225
font-size: 12pt;
226-
border: 1pt solid #3E3AFF;
226+
padding-right: 5pt;
227+
border: 2pt solid #3E3AFF;
227228
background-color: hsl(241, 100%, 99.5%);
228229
overflow: hidden;
229230
color: black;
230231
margin-top: 30pt !important;
231232
padding-top: 5pt;
232233
}
233234

234-
blockquote pre {
235-
position: relative;
236-
margin-left: -10pt;
237-
}
238235

239236
blockquote p {
240237
font-size: 12pt !important;
@@ -396,6 +393,7 @@ label.md-nav__title {
396393

397394
.md-sidebar__scrollwrap {
398395
background-color: #f6f6f6;
396+
height: calc(100vh - 80pt) !important;
399397
}
400398

401399
.overview .box {
@@ -638,4 +636,19 @@ code {
638636

639637
.md-nav--primary .md-nav__title[for=__drawer], .md-nav__title {
640638
background: transparent !important;
639+
}
640+
641+
blockquote pre {
642+
position: relative;
643+
margin-left: -10pt;
644+
}
645+
646+
blockquote code {
647+
border-radius: 0pt !important;
648+
border-left-width: 0pt;
649+
border-right-width: 0pt;
650+
}
651+
652+
ul.md-nav__list {
653+
font-weight: 400;
641654
}

docs/guardrails/ban-words.md

Whitespace-only changes.

docs/guardrails/code-validation.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Code Validation
2+
3+
<div class='subtitle'>
4+
Secure the code that your agent generates and executes.
5+
</div>
6+
7+
Code validation is a critical component of any code-generating LLM system, as it helps to ensure that the code generated by the LLM is safe and secure. Guardrails provides a simple way to validate the code generated by your LLM, using a set of pre-defined rules and checks.
8+
9+
> **Code Validation Risks**<br/>
10+
> Code validation is a critical component of any code-generating LLM system. For example, an insecure agent could:
11+
12+
> * Generate code that contains **security vulnerabilities**, such as SQL injection or cross-site scripting
13+
14+
> * Generate code that **contains bugs or errors**, causing the system to crash or behave unexpectedly
15+
16+
> * Produce code that escapes a **sandboxed execution environment**
17+
18+
> * Generate code that is **not well-formed or does not follow best practices**, causing the system to be difficult to maintain or understand

docs/guardrails/computer-use.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Computer Use Agents
2+
3+
<div class='subtitle'>
4+
Guardrail the actions of computer use agents, to enable safe UI interfacing.
5+
</div>
6+
7+
Computer use agents are powerful general-purpose reasoners, equipped with their own computer and the ability to interact with it. However, to ensure security and correctness properties, it is important to guardrail the actions of these agents, to prevent them from performing undesired or harmful actions.
8+
9+
> **Computer Use Agent Risks**<br/>
10+
> Computer use agents are powerful general-purpose reasoners, equipped with their own computer and the ability to interact with it. For example, an insecure agent could:
11+
12+
> * Perform actions that are **harmful or undesired**, such as ordering wrong items or sending messages to users
13+
14+
> * Switch applications or **perform actions that are conidered out-of-scope** for their intended use case
15+
16+
> * Being confused by the UI, and **performing actions that are not intended**, such as clicking on the wrong button or entering the wrong information
17+
18+
> * Being prompt-injected by UI elements and images, to perform **malicious actions as injected by an potential attacker**

docs/guardrails/copyright.md

Whitespace-only changes.

docs/guardrails/dataflow-rules.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Dataflow Rules
2+
3+
<div class='subtitle'>
4+
Secure the dataflow of your agentic system, to ensure that sensitive data never leaves the system through unintended channels.
5+
</div>
6+
7+
Due to their dynamic nature, agentic systems often mix and combine data from different sources, and can easily leak sensitive information. Guardrails provides a simple way to define dataflow rules, to ensure that sensitive data never leaves the system through unintended channels.
8+
9+
> **Dataflow Risks**<br/>
10+
11+
> Due to their dynamic nature, agentic systems often mix and combine data from different sources, and can easily leak sensitive information. For example, an insecure agent could:
12+
13+
> * Leak sensitive information, such as **API keys or passwords**, to an external service
14+
15+
> * Send sensitive information, such as **user data or PII**, to an external service
16+
17+
> * Be prompt-injected by an external service via indirect channels, to **perform malicious actions** as injected by an potential attacker

docs/guardrails/function-calls.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Function Calls
2+
3+
<div class='subtitle'>
4+
Guardrail the function and tool calls of your agentic system.
5+
</div>
6+
7+
At the core of any agentic systems are function and tool calls, i.e. the ability for the agent to interact with the environment via desiganted functions and tools.
8+
9+
For security and safety reasons, it is important to ensure that all tool calls an agent executes are validated and well-scoped, to prevent undesired or harmful actions.
10+
11+
> **Tool Calling Risks**<br/>
12+
> Since tools are an agent's interface to interact with the world, they can also be used to perform actions that are harmful or undesired. For example, an insecure agent could:
13+
14+
> * Leak sensitive information, e.g. via a `send_email` function
15+
16+
> * Delete an important file, via a `delete_file` or a `bash` command
17+
18+
> * Make a payment to an attacker
19+
20+
> * Send a message to a user with sensitive information

docs/guardrails/images.md

Whitespace-only changes.

docs/guardrails/loops.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
2+
# Loop Detection
3+
4+
<div class='subtitle'>
5+
Detect and prevent infinite loops in your agentic system.
6+
</div>
7+
8+
Loop detection is a critical component of any agentic system, as it helps to prevent infinite loops and other undesired behavior. Guardrails provides a simple way to detect and prevent loops in your agentic system.
9+
10+
> **Looping Risks**<br/>
11+
> Loops are a common source of bugs and errors in agentic systems. For example, an insecure agent could:
12+
13+
> * Get stuck in an infinite loop, **consuming resources and causing the system to crash**
14+
15+
> * Get stuck in a loop that causes it to **perform a irreversible action**, such as sending a message many times
16+
17+
> * Get stuck in a loop, requiring **many expensive LLM calls**, causing the system to run out of tokens or money

docs/guardrails/moderation.md

Whitespace-only changes.

0 commit comments

Comments
 (0)