Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 11 additions & 0 deletions Guardrails/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Guardrails Quickstart

## Optional Static Release-Readiness Check
This notebook uses `SerperDevTool()` for read-only web search. The scoped `shipgate.yaml` in this directory lets maintainers run [Agents Shipgate](https://github.com/ThreeMoonsLab/agents-shipgate) as an optional static release-readiness check for the tool surface.

Because this quickstart is a notebook, the local `tool-inventory.json` documents the tool exposed by the example. Agents Shipgate reads that local metadata without running the notebook, calling Serper, making LLM calls, or uploading source.

```bash
pipx install agents-shipgate
agents-shipgate scan -c Guardrails/shipgate.yaml --ci-mode advisory
```
25 changes: 25 additions & 0 deletions Guardrails/shipgate.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# yaml-language-server: $schema=https://raw.githubusercontent.com/ThreeMoonsLab/agents-shipgate/main/docs/manifest-v0.1.json

version: "0.1"

project:
name: crewai-guardrails-quickstart

agent:
name: guardrails-research-crew
declared_purpose:
- Research CrewAI topics through read-only web search and demonstrate task guardrail validation.

environment:
target: local

tool_sources:
- id: guardrails_tool_inventory
type: mcp
path: tool-inventory.json

permissions:
scopes:
- serper:search:read
credential_mode: api_key
notes: "Notebook quickstart uses SerperDevTool for read-only web search."
27 changes: 27 additions & 0 deletions Guardrails/tool-inventory.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"tools": [
{
"name": "Search the internet with Serper",
"description": "Search public web results for a user-provided research query through Serper.",
"inputSchema": {
"type": "object",
"properties": {
"search_query": {
"type": "string",
"description": "The web search query to run."
}
},
"required": ["search_query"],
"additionalProperties": false
},
"annotations": {
"readOnlyHint": true,
"idempotentHint": true
},
"auth": {
"scopes": ["serper:search:read"]
},
"owner": "crewai-quickstarts"
}
]
}