morluto/rea

Fork

You've already forked rea

mirror of https://github.com/morluto/rea.git synced 2026-11-05 06:45:22 +00:00

Code Issues 1.3k Projects Packages Wiki Activity

[GH-ISSUE #100] Complete actionable output schemas, structured results, and typed error details #66

New issue

Closed

opened 2026-10-15 18:20:44 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-15 18:20:44 +00:00

Owner

Copy link

Originally created by @morluto on GitHub (Jul 13, 2026).
Original GitHub issue: https://github.com/morluto/rea/issues/100

Summary

Finish the structured CLI/MCP contract work begun in REA 1.3.0 by preserving actionable, machine-readable error details consistently across tools and command surfaces.

The successful-result portion is largely shipped. The remaining work is error detail fidelity, permission remediation, cross-surface consistency, and validation that every contract remains precise.

Shipped in REA 1.3.0

Tool registrations publish outputSchema.
Successful values are validated before return.
Successful MCP calls return structuredContent.
Expected errors expose provider-neutral category and message fields.
Tool contract helpers centralize schema and annotations.
Package verification exercises the MCP catalog.

Implementation evidence includes PR #107 and the 1.3.0 release.

Remaining problem

The current safe error projection can discard evidence required to diagnose local artifacts. Example: direct ASAR inventory reduces an integrity mismatch to category plus generic remediation, removing:

logical entry path;
declared SHA-256;
calculated SHA-256;
embedded versus unpacked state.

The same underlying failure remains verbose through investigate-versions, so CLI surfaces are inconsistent. See #111.

Permission failures also need structured requested/allowed scope and remediation rather than generic disabled/outside-root messages.

Proposed error contract

Define a stable discriminated envelope containing code, category, safe message, retryability, per-code details, and structured remediation. Integrity details should include logical_path, declared_sha256, calculated_sha256, and unpacked.

Not every error needs every field. Each error code should have its own schema.

Suggested families:

invalid_request;
permission_required;
capability_unavailable;
provider_unavailable;
provider_timeout;
cancelled;
artifact_integrity_mismatch;
evidence_integrity_mismatch;
truncated;
process_capture_failed;
cleanup_incomplete;
revision_conflict;
outside_approved_root.

Redaction policy

Preserve evidence needed for local reproducibility:

hashes;
addresses;
artifact-relative paths;
entry types;
provider IDs;
classifications;
limits and truncation state.

Continue redacting:

tokens and credentials;
authorization headers;
environment values;
captured secret content;
raw subprocess output not explicitly approved.

If absolute paths require protection, use stable aliases or an explicit path-redaction policy rather than deleting identity-bearing details.

Permission error details

A permission_required result should identify:

capability requested;
requested executable/working/evidence/input roots as aliases or safe paths;
requested environment names, never values;
requested network mode;
active policy ceiling;
whether elicitation is supported;
exact configuration or retry action;
whether restart is required.

Acceptance criteria

Every registered MCP tool has an output schema.
Successful structuredContent validates against its schema.
Expected operational errors have stable discriminated codes and per-code detail schemas.
ASAR integrity mismatch includes logical path, declared/calculated digest, and unpacked state in CLI and MCP.
Permission errors identify missing scope and actionable remediation.
Cleanup, cancellation, truncation, and revision conflicts retain their distinct typed details.
CLI, MCP, direct inventory, and investigate-versions project the same underlying error consistently.
--full-output never contains less diagnostic information than normal structured output.
Text content remains concise and compatible while structuredContent retains details.
Sensitive values remain redacted without removing reproducibility metadata.
Contract tests validate every success and error variant across CLI and MCP.
Generated schemas/documentation identify error variants clients may handle.

Non-goals

Returning raw provider stack traces.
Exposing subprocess stderr indiscriminately.
Treating every programmer defect as a recoverable operational error.
Silently accepting integrity mismatches.

Relationships

#111 is the concrete diagnostic-loss regression and redaction-policy case.
#96 defines interactive permission grants.
#99 may expose large diagnostic evidence through resources.

Originally created by @morluto on GitHub (Jul 13, 2026). Original GitHub issue: https://github.com/morluto/rea/issues/100 ## Summary Finish the structured CLI/MCP contract work begun in REA 1.3.0 by preserving actionable, machine-readable error details consistently across tools and command surfaces. The successful-result portion is largely shipped. The remaining work is error detail fidelity, permission remediation, cross-surface consistency, and validation that every contract remains precise. ## Shipped in REA 1.3.0 - [x] Tool registrations publish outputSchema. - [x] Successful values are validated before return. - [x] Successful MCP calls return structuredContent. - [x] Expected errors expose provider-neutral category and message fields. - [x] Tool contract helpers centralize schema and annotations. - [x] Package verification exercises the MCP catalog. Implementation evidence includes PR #107 and the 1.3.0 release. ## Remaining problem The current safe error projection can discard evidence required to diagnose local artifacts. Example: direct ASAR inventory reduces an integrity mismatch to category plus generic remediation, removing: - logical entry path; - declared SHA-256; - calculated SHA-256; - embedded versus unpacked state. The same underlying failure remains verbose through investigate-versions, so CLI surfaces are inconsistent. See #111. Permission failures also need structured requested/allowed scope and remediation rather than generic disabled/outside-root messages. ## Proposed error contract Define a stable discriminated envelope containing code, category, safe message, retryability, per-code details, and structured remediation. Integrity details should include logical_path, declared_sha256, calculated_sha256, and unpacked. Not every error needs every field. Each error code should have its own schema. Suggested families: - invalid_request; - permission_required; - capability_unavailable; - provider_unavailable; - provider_timeout; - cancelled; - artifact_integrity_mismatch; - evidence_integrity_mismatch; - truncated; - process_capture_failed; - cleanup_incomplete; - revision_conflict; - outside_approved_root. ## Redaction policy Preserve evidence needed for local reproducibility: - hashes; - addresses; - artifact-relative paths; - entry types; - provider IDs; - classifications; - limits and truncation state. Continue redacting: - tokens and credentials; - authorization headers; - environment values; - captured secret content; - raw subprocess output not explicitly approved. If absolute paths require protection, use stable aliases or an explicit path-redaction policy rather than deleting identity-bearing details. ## Permission error details A permission_required result should identify: - capability requested; - requested executable/working/evidence/input roots as aliases or safe paths; - requested environment names, never values; - requested network mode; - active policy ceiling; - whether elicitation is supported; - exact configuration or retry action; - whether restart is required. ## Acceptance criteria - [x] Every registered MCP tool has an output schema. - [x] Successful structuredContent validates against its schema. - [ ] Expected operational errors have stable discriminated codes and per-code detail schemas. - [ ] ASAR integrity mismatch includes logical path, declared/calculated digest, and unpacked state in CLI and MCP. - [ ] Permission errors identify missing scope and actionable remediation. - [ ] Cleanup, cancellation, truncation, and revision conflicts retain their distinct typed details. - [ ] CLI, MCP, direct inventory, and investigate-versions project the same underlying error consistently. - [ ] --full-output never contains less diagnostic information than normal structured output. - [ ] Text content remains concise and compatible while structuredContent retains details. - [ ] Sensitive values remain redacted without removing reproducibility metadata. - [ ] Contract tests validate every success and error variant across CLI and MCP. - [ ] Generated schemas/documentation identify error variants clients may handle. ## Non-goals - Returning raw provider stack traces. - Exposing subprocess stderr indiscriminately. - Treating every programmer defect as a recoverable operational error. - Silently accepting integrity mismatches. ## Relationships - #111 is the concrete diagnostic-loss regression and redaction-policy case. - #96 defines interactive permission grants. - #99 may expose large diagnostic evidence through resources.

bsakaguchi

2026-10-15 18:20:44 +00:00

closed this issue
added the
area: mcp

enhancement
labels

bsakaguchi referenced this issue

2026-10-16 21:11:20 +00:00

[PR #79] [MERGED] Add evidence-backed investigation workflows #1817

bsakaguchi added

enhancement

and removed

enhancement

labels

2026-10-31 00:28:42 +00:00

No Branch/Tag specified

main

codex/procedure-reference-stacked

release-please--branches--main--components--rea-agents

release-please--branches--main--components--rea-agents--release-notes

codex/kuna-independent-retry

codex/byte-search-overlay-coverage

codex/open-failure-target-receipt

codex/kuna-xref-evidence

codex/ghidra-ambiguous-procedure-recovery

codex/function-source-bundle

codex/trace-function-integration-prototype

codex/snapshot-source-closure

codex/recorded-evidence-array-pages

codex/evidence-recovery-redesign

codex/trace-feature-address-scope

codex/call-discovery-scope

codex/ghidra-literal-candidate-evidence

codex/decompile-directory-independent-retry

codex/retry-provenance-base

codex/value-flow-capability-experiment

codex/ghidra-containing-instruction

cursor/readme-discord-button-ef9f

dependabot/github_actions/actions/setup-node-7.1.0

dependabot/github_actions/actions/upload-artifact-7.0.2

dependabot/npm_and_yarn/npm-minor-and-patch-d8d97ce6df

codex/kuna-1989

fix/8559-native-ui-fixture-ownership

fix/8555-go-verifier-mcp-ownership

codex/provider-capability-recovery

fix/8642-rizin-target-stdin

codex/ghidra-memory-effect-scope

codex/ghidra-annotation-entry-selector

codex/ghidra-readonly-recovery

codex/ghidra-regex-verifier-recovery

codex/evidence-discovery-view-guidance

fix/8545-bulk-append-overflow

fix/8428-navigation-refusal-alternatives

codex/address-context-recovery

codex/matching-member-limitations

codex/unknown-scope-contract

codex/evidence-view-guidance

feat/8373-native-trace-views

codex/ghidra-snapshot-verifier-binding

codex/elf-export-visibility

codex/evidence-view-recovery

codex/native-reference-cli-help

codex/provider-candidate-observation-scope

codex/kuna-session-verification

codex/ghidra-switch-lifetime-guidance

codex/pseudocode-paging-discovery

codex/clarify-evidence-view-support

codex/kuna-xrefs-selector-recovery

codex/context-capacity-recovery

codex/evidence-closure-large-links

codex/same-function-evidence-identity

codex/ghidra-verifier-inspected-jdk

codex/audit-guided-workflows

codex/crash-prompt-retained-dossiers

codex/analysis-view-error-recovery

codex/kuna-verifier-target-selection

codex/ghidra-selected-project-call-coverage

codex/docs-native-analysis-scope

codex/ghidra-java-socket-boundary

codex/ghidra-retained-snapshot-verifier

codex/ghidra-search-inventory-facts

fix/8284-zero-argument-parameter-bindings

fix/8198-ui-action-handler-offset

fix/8257-elf-entry-label-identity

fix/8304-deferred-output-schema-projection

fix/8277-call-path-computed-target-uncertainty

fix/pr-8089-conflicts

fix/ci-static-duplicate-export

dependabot/npm_and_yarn/lint-staged-17.6.0

dependabot/github_actions/actions/download-artifact-8.0.2

dependabot/npm_and_yarn/write-file-atomic-8.0.0

dependabot/npm_and_yarn/canonicalize-5.1.0

dependabot/github_actions/actions/cache/restore-6.1.0

dependabot/npm_and_yarn/toon-format/toon-4.4.0

dependabot/github_actions/actions/deploy-pages-5.0.1

codex/review-fixes-pr-2403

codex/review-fixes-pr-2400

codex/process-terminal-width

codex/test-brittleness-cleanup

verify/7167-browser-connect-macos

fix/7167-browser-connect

feat/native-matching-allowance-setting

feat/browser-scenario-dry-run

test/managed-caller-parameters-20261024

codex/parser-fortythird-boundaries

fix/6926-pinvoke-platform-decorations-20261023

fix/6889-har-body-encoding-20261023

fix/6888-sqlite-schema-budget-20261023

fix/dependency-security-gates-6708

cursor/evidence-overwrite-rebase-b4ac

feat/4057-verify-native-exports

fix/windows-acl-observer-overhead-20261022

cursor/erlang-beam-restack-4476

cursor/pe-certificate-review-bf32

fix/6116-javascript-application-fs-errors

fix/6061-unmapped-runtime-script-unknown

feat/browser-scenario-summary

fix/pe-certificates

codex/verify-3407

cursor/rebase-5699

cursor/rebase-5352

cursor/rebase-5600

cursor/fix-cli-schema-omission-10a8

codex/audit-hopper-shutdown-reasons-20261021

fix/demangle-swift-omitted-record

fix/nib-boolean-value-types

cursor/cancellation-partial-observation-a5ac

fix/ib-object-limit-reasons

fix/electron-fuse-limit-advice

fix/kuna-doctor-dangling-cache

fix/fixed-budget-refusal-advice

fix/js-ipc-listener-dedup

fix/js-return-member-provenance

fix/dmg-integrity-retry-advice

fix/ida-doctor-readiness

fix/kuna-version-probe-output-drain

fix/legacy-swift-runtime-name-matching

fix/dylib-lazy-load-commands

fix/browser-scenario-startup-cancel

fix/swift-nested-punycode-classification

fix/compare-unselected-scopes

fix/objc-method-budget-coverage

fix/dmg-mounted-root-observations

audit/ci-tests-20261019-round2

release/6.7.0

fix/wabt-cleanup-retry-resolution

fix/electron-fuse-elf-pe-architecture

fix/native-plist-descriptor-ownership

fix/kuna-caller-cleanup-ownership

experiment/atomic-codemode-20261016

review/first-contributor-3776

fix/call-resolution-full-read-cycles

fix/member-mutation-selection-repeat

experiment/atomic-re-tools-20261015

perf/member-mutation-lazy-origins

perf/static-network-mutation-index

fix/hopper-startup-lifecycle

audit/3050-windows-proof-20261015

feat/windows-window-capture-2183

audit/3049-windows-proof-20261015

audit/3735-macos-fixtures-20261015

fix/batch-decompile-null-pseudocode

fix/kuna-inventory-honors-jobs

experiment/browser-codemode-tool-design-20261015

fix/hopper-clean-runtime-argv

codex/review-2049-27f1b367

review-fixes/pr-2787-routing

fix/3360-scoped-this-emitters

fix/3367-replaced-global-effects

fix/3838-compact-any-value-items

test/hopper-download-probe-20261015

codex/windows-runtime-creation-red-green-20261015

codex/windows-readonly-root-red-green-20261015

codex/windows-root-share-red-green-20261015

codex/exp-1685-win-mcp-startup

codex/bug-sweep-20261015

investigate/2190-windows-package-phases

investigate/3543-macos-cli-deadline

perf/3281-reverse-tools-feedback-quality

fix/3406-hopper-doctor-fixture

fix/3341-wrapper-require-test-context

fix/3301-owned-uninstall-fixtures

fix/3164-compiler-input-ownership

fix/pcap-cleanup-stdout-newline-20261014

perf/interface-builder-summary

codex/review-fixes-pr-1977

fix/ghidra-effective-jvm-platform

fix/docs-turkish-rust-link-20261013

fix/main-maintenance-ci-20261010

fix/recover-binary-session-process-effects

codex/review-fixes-pr-2457

codex/ci-required-cancellation-gate

fix/main-format-baseline-20261013

fix/setup-preserve-entry-fields

cursor/restore-main-checks-1ffc

fix/ghidra-bridge-hashmap-import

codex/shared-ci-jadx-json-default-20261013

codex/shared-ci-ghidra-test-groups-20261013

codex/shared-ci-java-fixture-format-20261013

codex/fix-intrinsic-invocation-boundaries

test/release-preflight-reusable-jobs

test/js-parameter-provenance-expectation

fix/linux-hopper-verification-current

test/2419-ghidra-elf-probe-size

followup/pr-1544-native-ida

codex/fold-pr-2230-contribution

docs/readme-responsible-use

fix/issue-2064

fix/issue-2050

fix/issue-2053

fix/issue-1968

fix/issue-1945

experiment/codemode-bridge-20261011

fix/tool-effects-negative-wording-1904-20261012

fix/1842-electron-interop-provenance

feat/recover-javascript-multi-input

refactor/website-i18n-prep

fix/nativeaot-pe-virtual-extent

fix/browser-verifier-ci-hang

fix/pe-resources-input-selection

docs/beginner-friendly-guides

docs/beginner-setup-guide

fix/javascript-analysis-worker-1563

fix/1649-ghidra-duplicate-names

fix/javascript-export-keys-integration-1369

test/maintenance-boundary-contracts-20261011

review/javascript-export-keys-1369

review/process-live-progress-1483

test/javascript-1495-growth-ratio

fix/ci-escape-timing

docs/normalized-terminal-geometry-1450

release/6.3.0

archive/release-6.3.0-pr1381

release/6.2.0

fix/electron-preload-dynamic-override

fix/javascript-self-referential-bundler-edges

release/6.1.0

cursor/grok-client-cherry-pick-0b56

feat/signature-posture

feat/dyld-shared-cache

feat/artifact-integrity-policy

feat/pkg-inventory

release/6.0.0

chore/sync-release-5.0.0

release/5.0.0

cursor/cloud-agent-node-787e

fix/javascript-xhr-open-endpoints

review/pr-711-realpath-fallback-wording

cleanup/replay-confinement

codex/test-suite-performance

codex/issue-foundations

codex/address-open-issues-2026-07-20

agent/javascript-vite-rollup-esbuild-adapters

agent/process-cleanup

agent/triage-integration

agent/unknown-commands-registry

feat/mcp-identity-metadata

morlvps/issue_cleanup

codex/installer-redesign

morl/roadmap-investigation-core

morl/roadmap-investigation-docs

release-please--branches--main--components--rea

rea-agents-6.8.0

rea-agents-6.7.0

rea-agents-6.6.0

experiment/atomic-codemode-wait-runtime-20261016

rea-agents-6.5.0

rea-agents-6.4.0

rea-agents-6.3.0

rea-agents-6.2.0

rea-agents-6.1.0

rea-agents-6.0.0

rea-agents-5.0.0

rea-agents-4.1.0

rea-agents-4.0.1

rea-agents-4.0.0

rea-agents-3.2.1

rea-agents-3.2.0

rea-agents-3.1.0

rea-agents-3.0.0

rea-agents-2.7.0

rea-agents-2.6.0

rea-agents-2.5.1

rea-agents-2.5.0

rea-agents-2.4.0

rea-agents-2.3.0

rea-agents-2.2.0

rea-agents-2.1.0

rea-agents-2.0.0

rea-agents-1.7.0

rea-agents-1.6.0

rea-agents-1.5.0

rea-agents-1.4.0

rea-agents-1.3.0

rea-agents-1.2.0

rea-agents-1.1.0

rea-agents-1.0.0

rea-agents-0.5.0

rea-agents-0.4.0

rea-agents-0.3.0

rea-0.2.1

rea-0.2.0

Labels

Clear labels

Mirrored from GitHub Pull Request

No labels

Milestone

Clear milestone

No items

No milestone

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

morluto/rea#66

Reference in a new issue

Repository

morluto/rea

Title

Body

No description provided.

Delete branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?

Rows
Columns