Skip to main content

Manifest-first release readiness scanner for agent tool surfaces.

Project description

Agents Shipgate

License Python

The pre-flight check your agent release is missing.

Agents Shipgate is an Agent Release Gate: a static, manifest-first scanner that catches risky agent tool configurations at PR time. It reads shipgate.yaml, local MCP tool exports, local OpenAPI specs, simple OpenAI API prompt/tool/schema artifacts, optional OpenAI Agents SDK AST metadata, and Google ADK static metadata, then writes Markdown, JSON, and SARIF reports for release review.

An agent release gate is the static, manifest-based pre-flight check that runs on agent PRs before promotion to staging or production. Today, most agent teams ship without one.

Findings Gallery

The bundled support-refund fixture demonstrates the kind of release risks Agents Shipgate is designed to surface:

## Agents Shipgate

Status: Release blockers detected
Critical: 2 - High: 14 - Medium: 2
Human review: recommended

Top findings:
1. stripe.create_refund lacks a declared approval policy
2. stripe.create_refund lacks idempotency evidence
3. Manifest declares broad permission scopes
  • stripe.create_refund lacks a declared approval policy, so a financial action could ship without an explicit human review gate.
  • stripe.create_refund.amount lacks a maximum bound, weakening blast-radius control.
  • stripe.create_refund lacks idempotency evidence while retry behavior is known, risking duplicate refunds.
  • wildcard_mcp_tools.* exposes a wildcard tool surface, making review incomplete.
  • gmail.send_customer_email overlaps a prohibited external-communication action without a matching confirmation policy.

Why Not Just...

Alternative Gap Agents Shipgate Covers
Unit tests Tests usually validate code paths, not the released tool surface and declared policies.
Code review Reviewers miss generated specs, MCP exports, broad scopes, and missing approval policies.
Runtime traces Useful later, but they arrive after behavior exists. Agents Shipgate runs before promotion.
Nothing Tool-surface drift becomes a production surprise.

Quickstart

Use Agents Shipgate as a GitHub Action on every PR, or run the CLI locally.

Install the published package:

python -m pip install agents-shipgate
agents-shipgate --version

Install from a source checkout when developing locally:

python -m pip install -e ".[dev]"
agents-shipgate init --workspace . --write
agents-shipgate doctor --config shipgate.yaml
agents-shipgate scan --config shipgate.yaml

Or install directly from GitHub when testing the latest unreleased source:

python -m pip install "git+https://github.com/ThreeMoonsLab/agents-shipgate@main"

Try the bundled fixture:

agents-shipgate scan --config samples/support_refund_agent/shipgate.yaml
agents-shipgate scan --config samples/simple_openai_api_agent/shipgate.yaml
agents-shipgate scan --config samples/google_adk_agent/shipgate.yaml
agents-shipgate scan --config samples/clean_read_only_agent/shipgate.yaml

CI Behavior

CI is advisory by default:

agents-shipgate scan --config shipgate.yaml --ci-mode advisory

Strict mode exits with code 20 only when unsuppressed critical findings exist. Configuration, input parsing, and internal tool errors use 2, 3, and 4 respectively:

agents-shipgate scan --config shipgate.yaml --ci-mode strict

For existing projects, save the current reviewed findings as a local baseline and fail strict CI only on new unsuppressed findings:

agents-shipgate baseline save --config shipgate.yaml --out .agents-shipgate/baseline.json
agents-shipgate scan --config shipgate.yaml --baseline .agents-shipgate/baseline.json --ci-mode strict

Teams can override severities and CI failure thresholds:

checks:
  severity_overrides:
    SHIP-AUTH-MISSING-SCOPE: critical
ci:
  fail_on:
    - critical
    - high

Google ADK

v0.3 adds static Google ADK support for Python entrypoints and Agent Config YAML. The adapter detects LlmAgent/Agent definitions, function tools, OpenAPIToolset, McpToolset, callbacks, plugins, sub-agents, eval references, and explicit local tool inventories without importing ADK code.

version: "0.1"
project:
  name: adk-support-agent
agent:
  name: support-agent
  declared_purpose:
    - handle support cases
environment:
  target: production_like
tool_sources:
  - id: adk
    type: google_adk
    path: agent.py
google_adk:
  eval_sets:
    - evals/support.eval.json
  tool_inventories:
    - inventories/adk-mcp-tools.json

Dynamic ADK toolsets produce warnings or findings unless you provide explicit MCP, OpenAPI, or local tool inventory inputs.

Who It Is For

Buyer Pain Pitch Next step
Platform engineer shipping a first production agent "I don't know what I don't know." Audits manifest and tool schemas for release risks code review misses. Run agents-shipgate init --workspace . --write.
Security or GRC reviewer "Agents bypass existing controls." Creates a static tool-surface audit trail for review. Review the check catalog.
AI PM with a shipping deadline "Security review blocks us late." Gives teams self-serve pre-review before formal approval. Scan the support-refund fixture.

Limitations

Agents Shipgate is a static, manifest-first scanner. It is intentionally narrow:

  • It does not run agents, call tools, invoke LLMs, or verify model availability.
  • It does not verify runtime behavior, latency, prompt quality, or routing decisions.
  • It does not replace dynamic security testing or human security review of the underlying systems.
  • It only inspects what is declared in shipgate.yaml, local OpenAPI specs, MCP exports, simple OpenAI API artifacts, optional SDK AST metadata, and static Google ADK inputs; tools that are not declared or statically discoverable are not scanned.
  • The manifest remains version: "0.1" in v0.3 so existing configs keep working. Reports add report_schema_version: "0.3" while preserving the v0.1 payload keys.

See ROADMAP.md for what is planned next.

Trust Model

Agents Shipgate does not import user code, run agents, call tools, call LLMs, connect to MCP servers, make network calls, or collect telemetry by default.

See Trust model and Security policy for the default local-only guarantees and disclosure process.

GitHub Action

Use a pinned release tag for CI. Set permissions: contents: read and run on pull_request:

name: Agents Shipgate

on:
  pull_request:

permissions:
  contents: read

jobs:
  agents-shipgate:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
      - id: agents-shipgate
        uses: ThreeMoonsLab/agents-shipgate@v0.3.0
        with:
          config: shipgate.yaml
          ci_mode: advisory
          output_dir: agents-shipgate-reports

For PR comments, add pull-requests: write to the job's permissions and set pr_comment: "true".

Inputs: config, ci_mode (advisory or strict), fail_on, baseline, baseline_mode, no_plugins, output_dir, upload_artifact, pr_comment, github_token, shipgate_version.

Outputs: status, critical_count, high_count, medium_count, baseline_new_count, baseline_matched_count, baseline_resolved_count, adk_agent_count, adk_dynamic_toolset_count, report_json, report_markdown, report_sarif, exit_code.

Set shipgate_version to install a pinned PyPI release instead of the action source when your workflow requires package/version parity.

Pricing And Open Source Stance

Agents Shipgate is and will remain free OSS for individuals and teams running it on their own infrastructure. The core manifest-first scanner, built-in checks, Markdown report, and JSON report are intended to remain open source. We do not collect telemetry and do not require an account.

If hosted dashboards, SSO, org-wide baselines, approval workflows, or trace-based evidence emerge, they should live in a separate optional product rather than moving core OSS functionality behind a paywall.

Docs

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

agents_shipgate-0.3.0.tar.gz (147.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

agents_shipgate-0.3.0-py3-none-any.whl (87.9 kB view details)

Uploaded Python 3

File details

Details for the file agents_shipgate-0.3.0.tar.gz.

File metadata

  • Download URL: agents_shipgate-0.3.0.tar.gz
  • Upload date:
  • Size: 147.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for agents_shipgate-0.3.0.tar.gz
Algorithm Hash digest
SHA256 3c1a91922e98bb0c09854a9fd9cbd67d876043211fb415ffe652a3a2dd55162c
MD5 207bd318c7dc050f8639d098e5bceef3
BLAKE2b-256 6efcd6044f280785a7f4931ab3036fb872719743f31b59d6f98d6e09cdfa047e

See more details on using hashes here.

File details

Details for the file agents_shipgate-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: agents_shipgate-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 87.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for agents_shipgate-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d154ebbcff7ae7175f950febffec8615e66749e5eb39b21b20cf50519e26e60b
MD5 3a73c967302a5681d14340f663b025cd
BLAKE2b-256 de6ab094a4c7ffc3f860e7926ba5f7418951add9c9fc5af0cb43609050439afd

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page