Read a document's native annotations into a review set.
Use describe("common.parse.review") when your code needs the complete live JSON Schemas.
At a glance
| Property | Value |
|---|---|
| Package | @runstamp/review-operations |
| Domain / verb | common / parse |
| Customer jobs | read |
| Deterministic | Yes |
| Side effects | none |
Availability
| Local | SDK | CLI | MCP | Managed API |
|---|---|---|---|---|
| public ga | public ga | public ga | public ga | public ga |
Managed API route: POST /api/v2/operations/common/parse/review. Managed execution requires a free-trial workspace or an active Platform or Enterprise workspace, and an environment-bound API key.
Input and result
| Schema | Required fields | Optional fields |
|---|---|---|
| Input | source | none |
| Options | none | operation, deterministic, deterministicSeed, timeoutMs, limits, locale, lossPolicy |
| Result value | output, artifacts | none |
Every success also carries losses, diagnostics, and a hash-bound receipt.
Defaults, limits, and format constraints
Defaults
| Path | Default |
|---|---|
$.deterministic | default=true |
$.lossPolicy | default="collect" |
Formats and profiles
| Path | Constraint |
|---|---|
$.source.schemaVersion | const=1 |
$.source.version | pattern="^[A-Za-z0-9][A-Za-z0-9._:-]{0,255}$" |
Other limits
| Path | Constraint |
|---|---|
$.source.artifactId | pattern="^[A-Za-z0-9][A-Za-z0-9._:-]{0,255}$" |
$.source.sourceSha256 | pattern="^[a-f0-9]{64}$" |
$.source.tenantId | pattern="^[A-Za-z0-9][A-Za-z0-9._:-]{0,255}$" |
$.source.byteLength | minimum=0maximum=16000000 |
$.source.importedItems | maxItems=10000 |
$.source.importedItems[].id | pattern="^[A-Za-z0-9][A-Za-z0-9._:-]{0,255}$" |
$.source.importedItems[].body | minLength=1maxLength=64000 |
$.source.importedItems[].author.id | pattern="^[A-Za-z0-9][A-Za-z0-9._:-]{0,255}$" |
$.source.importedItems[].author.displayName | minLength=1maxLength=256 |
$.source.importedItems[].parentId | pattern="^[A-Za-z0-9][A-Za-z0-9._:-]{0,255}$" |
$.source.importedItems[].anchor.locator.artifactId | pattern="^[A-Za-z0-9][A-Za-z0-9._:-]{0,255}$" |
$.source.importedItems[].anchor.locator.value | minItems=1maxItems=16 |
$.source.importedItems[].anchor.locator.value[].anyOf[0] | maxLength=512 |
$.source.importedItems[].anchor.locator.value[].anyOf[1] | minimum=0 |
$.source.importedItems[].anchor.targetText | maxLength=4096 |
$.source.importedItems[].anchor.targetSha256 | pattern="^[a-f0-9]{64}$" |
$.source.importedItems[].anchor.contextBefore | maxLength=1024 |
$.source.importedItems[].anchor.contextAfter | maxLength=1024 |
$.source.importedItems[].anchor.contextSha256 | pattern="^[a-f0-9]{64}$" |
$.source.importedItems[].geometry.width | minimum=0 |
$.source.importedItems[].geometry.height | minimum=0 |
$.source.importedItems[].geometry.page | minimum=0 |
$.source.importedItems[].nativeType | minLength=1maxLength=256 |
$.source.losses | maxItems=10000 |
$.source.losses[].code | pattern="^[A-Z][A-Z0-9_]{2,127}$" |
$.source.losses[].message | minLength=1maxLength=2000 |
Showing 32 of 55 constraints. Use describe() or the machine-readable reference for the complete schema.
Invoke
const input = await fetch("https://runstamp.com/demo-evidence/operation-evidence/review-operations/common.parse.review/input.json").then((response) => response.json());
const result = await runstamp.run("common.parse.review", input);
if (!result.ok) throw new Error(`${result.error.code}: ${result.error.remediation}`);
console.log(result.value, result.losses, result.diagnostics, result.receipt);curl -fsS https://runstamp.com/demo-evidence/operation-evidence/review-operations/common.parse.review/input.json -o input.json
npx -p @runstamp/sdk runstamp ops invoke common.parse.review --input input.json{
"tool": "runstamp_invoke_operation",
"arguments": {
"operation": "common.parse.review",
"input": "<JSON from https://runstamp.com/demo-evidence/operation-evidence/review-operations/common.parse.review/input.json>",
"execution_mode": "local"
}
}Errors and losses
Declared errors (12)
common/INVALID_INPUTcommon/PERMISSION_DENIEDcommon/BINDING_MISMATCHcommon/SHIFTED_ANCHORcommon/RESOURCE_LIMITcommon/ABORTEDcommon/VERIFICATION_FAILEDcommon/SCHEMA_REJECTEDcommon/OPERATION_CANCELLEDcommon/OPERATION_TIMEOUTcommon/CONTRACT_VIOLATIONcommon/LOSS_POLICY_VIOLATED
Declared losses (5)
common/NATIVE_ANNOTATION_OPAQUEcommon/NATIVE_ANNOTATION_UNSUPPORTEDcommon/REVIEW_TARGET_DELETEDcommon/REVIEW_SIDECAR_ONLYcommon/WORKSPACE_ADAPTER_UNAVAILABLE
SDK AbortSignal, CLI exit 130, and MCP cancellation return the typed common/OPERATION_CANCELLED failure envelope.
Verified example and exact contract
- Fixture:
icp-workflow(Lattice Harbor Software · Q2 FY2026 Quarterly Business Review). - Example input — SHA-256
83fdedf0e0319ec0fc813e2bea10515994645db58ffbc396ecc35e0c3b4ba410. - Example result — SHA-256
1f0f25bd42b2ffc02abac46e2d45d2e2bd58f3197f3e54cd41e2392136cb42e0. - Verified result SHA-256:
92e40092fc572b7e2dcc14d00c51683389cd57b1734d7f94bc7bcd229e5263a6. - Qualification lane:
12-approval-forms-review.
Contract fingerprints
- Descriptor:
76617e4703de7d8f9926fef50cc76bd73b9f746f22cbfa26ca9f96cfafa5d4be. - Input schema:
da48c5ff3f562eadb09e81087ce4fdbde049be5216db5e7d7cf117bfee300c1b. - Options schema:
26a3867ab1aaa645f9e84b11155a1cc87d18854d19da924d894443fd689f0ee8. - Result value schema:
a5ecb2f77d18a04f8e20fd27dad70bee714423b47fa728fc8d12fb545efbc6dd.
The machine-readable operation reference publishes the complete schemas, qualification results, and evidence bindings for every operation.