diff --git a/docs/configuration.mdx b/docs/configuration.mdx index af9515b..f7d540b 100644 --- a/docs/configuration.mdx +++ b/docs/configuration.mdx @@ -156,7 +156,7 @@ Unlike the PII Redactor, `entities` defaults to only the high-risk set: `credit_ Note that `block_entities` stops the run whatever `action` is set to, so `action: 'log'` is only observe-only if you also set `block_entities` to `[]`. -This middleware acts on the response rather than the prompt, because the tool calls it guards are proposed by the model. It has no mutating action, since a proposed tool call belongs to the paused turn the provider recorded. +This middleware acts on the response rather than the prompt, because the model proposes the tool calls it guards. It has no mutating action, since a proposed tool call belongs to the paused turn the provider recorded. ## Tool approval resumes diff --git a/docs/contributor-resources/support.mdx b/docs/contributor-resources/support.mdx index 44553b5..6ca2549 100644 --- a/docs/contributor-resources/support.mdx +++ b/docs/contributor-resources/support.mdx @@ -6,7 +6,7 @@ sidebarTitle: "Support utilities" `promptphp/intercept-support` provides shared support utilities and configuration for the Intercept middleware ecosystem. -Most users do not need to install or use this package directly. It is installed automatically when required by an Intercept middleware package. +Most users do not need to install or use this package directly. Composer installs it automatically when an Intercept middleware package requires it. The support package provides shared infrastructure used across Intercept packages, including: @@ -45,7 +45,7 @@ $config = InterceptConfig::middleware('injection_guard', [ ]); ``` -The helper merges the published config section with the middleware's internal defaults. If the section is missing, the defaults are returned. +The helper merges the published config section with the middleware's internal defaults. If the section is missing, the helper returns the defaults. ## Missing config sections diff --git a/docs/index.mdx b/docs/index.mdx index 73627e0..cf44698 100644 --- a/docs/index.mdx +++ b/docs/index.mdx @@ -79,9 +79,9 @@ It is especially useful for: Intercept is not a complete AI security platform. -It is a practical middleware layer that helps you add a final line of defense before prompts reach an AI provider. +It is a practical middleware layer that helps you add a final line of defence before prompts reach an AI provider. -It should be used alongside other controls, including: +Use it alongside other controls, including: - tool permission checks - client-side and server-side validation diff --git a/docs/middleware/pii-redactor.mdx b/docs/middleware/pii-redactor.mdx index 50bb870..74f7f9b 100644 --- a/docs/middleware/pii-redactor.mdx +++ b/docs/middleware/pii-redactor.mdx @@ -76,7 +76,7 @@ By default, the middleware will: The recommended default action is `redact`. -Some entities can still be blocked even when the action is `redact`. By default, credit cards, API keys, and bearer tokens are blocked. +Some entities can still be blocked even when the action is `redact`. By default, the middleware blocks credit cards, API keys, and bearer tokens. ## Supported entities diff --git a/docs/middleware/tool-approval-guard.mdx b/docs/middleware/tool-approval-guard.mdx index a9b7662..62b4261 100644 --- a/docs/middleware/tool-approval-guard.mdx +++ b/docs/middleware/tool-approval-guard.mdx @@ -63,7 +63,7 @@ class SupportAgent implements Agent, HasMiddleware ## How it differs from the other middleware -This is the first Intercept middleware that acts on the **response** rather than the prompt, because the tool calls it guards are proposed by the model. +This is the first Intercept middleware that acts on the **response** rather than the prompt, because the model proposes the tool calls it guards. ```mermaid placement="top-right" flowchart LR diff --git a/docs/quickstart.mdx b/docs/quickstart.mdx index a09c714..931d415 100644 --- a/docs/quickstart.mdx +++ b/docs/quickstart.mdx @@ -121,7 +121,7 @@ The prompt sent to the provider becomes something like: Please summarize this ticket for [EMAIL_1]. ``` -High-risk entities such as credit cards, API keys, and bearer tokens are blocked by default. +PII Redactor blocks high-risk entities such as credit cards, API keys, and bearer tokens by default. ## Recommended local setup