Skip to main content

Release Management

Short answer

Create or update a catalog release with upsert_release, load it (or list the catalog) with get_release, then use manage_test_run to add a test run, update status, and find or link batches in the prior-to-current commit range. Auth is the project API key only.

Common scenarios​

Create a release and attach coverage​

  1. Call upsertRelease with { "version": "<label>", "gitCommitSha": "<cut sha>" } (optional priorReleaseVersion).
  2. Call manageTestRun with { "release": "<label>", "commitRange": "MCP_TEST_RUN_COMMIT_RANGE_FIND" } to create the run and list unlinked batches in the prior-release-to-current commit range.
  3. If the user agrees, call manageTestRun again with the returned id and "commitRange": "MCP_TEST_RUN_COMMIT_RANGE_LINK" (or pass explicit batchInvocationIds).

Read plan and credits first with getOrgCapabilities when the agent should adapt to indie / teams / trial and ChimpHands credit remaining.

List or fetch a release​

getRelease returns one catalog entry when version is set. Omit version to list (excludeArchived, environment, paging).

CI quality gate​

  1. Call getRelease with { "version": "<label>", "detail": "MCP_RELEASE_VIEW_GATE" }.
  2. Apply your policy on summary.environmentStats, summary.issueStats, and summary.scanSummaries.

See the full curl/jq example in Programmatic release gating.

Agent / ExploreChimp targeting​

Use getRelease for the thin catalog (SHA, prior release, focus areas).

Security scan reporting​

StepOperation
Load scan configgetSecurityScanConfig
ProgressupdateScanProgress
FindingsreportScanFindings with scanner DAST / SAST / DEPS / SECRETS

Frequently asked questions

Which endpoint gates CI?

POST /api/mcp/get_release with { version, detail: MCP_RELEASE_VIEW_GATE }. Apply your own policy on the returned summary and detail.

How does an agent create a release and attach coverage?

POST /api/mcp/upsert_release, then manage_test_run with commitRange FIND to offer batches in the prior-to-current range, and manage_test_run again with commitRange LINK if the user wants them attached.

Related pages