diff --git a/Guardrails/README.md b/Guardrails/README.md new file mode 100644 index 0000000..01f055a --- /dev/null +++ b/Guardrails/README.md @@ -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 +``` diff --git a/Guardrails/shipgate.yaml b/Guardrails/shipgate.yaml new file mode 100644 index 0000000..dfb7481 --- /dev/null +++ b/Guardrails/shipgate.yaml @@ -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." diff --git a/Guardrails/tool-inventory.json b/Guardrails/tool-inventory.json new file mode 100644 index 0000000..b11ddf6 --- /dev/null +++ b/Guardrails/tool-inventory.json @@ -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" + } + ] +}