GitHub CI Gate
Run AgentReady as a public GitHub Action with minimum permissions.
The GitHub Marketplace Action checks OpenAPI or MCP contracts in CI, writes agentready.json and a Markdown report, and can fail a pull request when policy thresholds are breached. AgentReady Community is available for free; AgentReady Pro is in preparation.
permissions:
contents: read
steps:
- uses: actions/checkout@v4
- uses: BACOUL/timeproofs@agentready-action-v0.1.0-alpha.0
with:
file: openapi.json
type: openapi
min-score: "75"
fail-on: critical
out: agentready-ci
Immutable and full-SHA pinning
Use the immutable Action tag for readable workflows or the full implementation SHA for maximum pinning precision.
uses: BACOUL/timeproofs@agentready-action-v0.1.0-alpha.0
uses: BACOUL/timeproofs@d6634d0fbbe1fced510fc49d8871d52a3dc7f348
Outputs
scorestatusreport-pathcontract-path
Expected policy failures still preserve generated outputs and reports.
PASS and policy FAIL are both intentional outcomes.
A PASS lets the workflow proceed. A valid policy FAIL blocks the workflow while keeping report artifacts available for review.
ScanThe Action runs local static analysis only.
Use the CLIFor local runs, use npx @timeproofs/agentready@alpha.
Write outputsMarkdown and agentready.json are generated in the configured output directory.
Fail on policyThresholds such as critical findings can stop the build without contacting TimeProofs.
TimeProofs AgentReady does not guarantee that an AI agent will never fail. It identifies structural risks that may cause AI agents to misuse APIs, tools or MCP servers. The Action does not call live APIs, live MCP servers, hosted scanners, LLMs, gateways or telemetry endpoints.
AgentReady at a glance
The AgentReady GitHub Action runs static contract checks in a repository workflow with minimum read permissions and immutable pinning guidance. AgentReady is a product and candidate open standard for static pre-deployment analysis. It is not a runtime firewall, independent certification, official standards-body standard or guaranteed-safety system.
- Availability
- AgentReady Community is free and available. AgentReady Pro is planned and not purchasable.
- Language
- English is the current canonical language. No translated alternate route is published for this page.
Sources
AGENTREADY_MASTER_PLAN.mdGLOBAL_STANDARD_SITE_PROGRAM.mdSEO_GEO_AI_FIRST_REQUIREMENTS.mdSITE_COPY_GUIDE.mdGITHUB_ACTION_USAGE.md