Skip to content

Latest commit

 

History

History
41 lines (30 loc) · 1.51 KB

generic.md

File metadata and controls

41 lines (30 loc) · 1.51 KB

Generic AI agent integration

Install Guard and initialize the project before adding an agent instruction:

pnpm add -D @codapult/guard
pnpm exec codapult-guard init

Guard is discoverable in the official MCP Registry as io.github.codapult/guard. If the host does not import Registry entries, register the local stdio command pnpm exec codapult-guard mcp-server in its MCP configuration.

Add the following to the agent's project instructions:

After completing a coding task, call codapult_guard_next_action and follow its bounded next step.
Normally call codapult_guard_context, then codapult_guard_review with the requirement and changed
diff, then codapult_guard_verify. If the result contains an error, fix it and repeat up to
completionGate.maxIterations. Do not hide warnings or claim completion without reporting
unresolved requirements.

The CLI equivalent is:

codapult-guard review --requirement docs/acceptance.md
codapult-guard verify --json

For pull-request CI, verify against the protected base policy. Fetch the base commit before this step and pass its SHA (the bundled docs/guard-ci.yml does this automatically):

codapult-guard verify --policy-base "$BASE_SHA" --json

Use --fail-on-policy-change in a separate policy-review gate when changing Guard policy requires an explicit protected approval.

Use the host's post-task hook to invoke the sequence. Run the same command independently in CI.