[GH-ISSUE #2454] fix: reconcile documentation and MCP contracts with current behavior #821

New issue

Closed

opened 2026-10-15 18:28:45 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented 2026-10-15 18:28:45 +00:00

Owner

Copy link

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

Originally assigned to: @N0zoM1z0 on GitHub.

Problem

A documentation/behavior audit at main f254f5ac2b804b353a711264bb178f43fdf07867 confirmed the following 12 inconsistencies. Findings were checked against source owners and, where applicable, actual public CLI/SDK-connected stdio MCP workflows. Root READMEs/translations and website/ are outside this work.

Runtime contracts and tool guidance

• D09: Harmony archive session outputs. The domain recognizes .hap, .hsp and .app (app-pack), but the shared session output-format enum omits all three. Actual MCP open_binary and binary_session return output-validation errors even though the target becomes active and inspect_artifact succeeds. CLI inventory/projection succeeds. The Harmony verifier currently only submits CLI-produced Evidence to MCP projection and misses the opener/status journey. Fix the owning format contract and exercise the complete public lifecycle.
• D12: Unsupported native summary recommendation. The live inspect_analysis_view description recommends view: {kind: "summary"} for native function Evidence, while the native projector accepts kind: "native" facets. Actual current SDK calls reject summary and accept a procedure facet for the same authentic parent. Correct the description to match supported behavior.

Documentation accuracy

• D05: docs/installation.md incorrectly groups Qoder, Trae, ZCode and Hermes under ~/.agents/skills; isolated public setup dry-runs show dedicated client roots. Reuse the authoritative client configuration guide.
• D02: docs/raw-binary.md says Windows Ghidra P0 accepts PE applications only, although native PE DLLs are admitted too.
• D06: docs/javascript-runtime-reconciliation.md omits supported target-only partial capture_electron_scenario Evidence from its exclusive producer list.
• D07: The native/artifact skill reference says extract_artifact takes no arguments; it accepts optional integrity_policy, confirmed with real ZIP extraction.
• D04: The ADB guide says am is not exposed while fixed-vector app/activity lifecycle operations use am start -W and am force-stop.
• D11: SECURITY.md describes every owned provider bridge as a Unix socket, omitting Windows Ghidra's authenticated loopback TCP and private NTFS descriptor boundary.
• D03: The RISC-V guide calls RVE a 15-register ABI. RV32E/RV64E define 16 architectural GPRs, x0–x15, including the zero register. See the official ISA.
• D01: The managed guide's #managednative-boundary-rules link does not match installed VitePress's #managed-native-boundary-rules anchor. Preserve navigation in both repository and rendered docs.

Records and operational prerequisites

• D10: License records claim complete locked dependency coverage but list 561 entries versus 586 in the audited lockfile, omitting 25 Frida-related optional runtime entries. detect-libc is also still classified as development; runtime notices lack a Frida entry. Refresh from the actual lockfile/archives and preserve upstream texts. This finding is a record-coverage gap, not a legal conclusion.
• D08: The release synchronization guide requires a PR merge commit, while the repository currently disables that merge method. Document the maintainer prerequisite and ancestry requirement without silently changing repository settings or substituting squash/rebase.

Acceptance

• Recheck every finding against updated main before editing; already-fixed items need verification rather than duplicate changes.
• Correctness first; concise English guidance, shared rules maintained at their owning source, necessary limits and recovery steps retained.
• Preserve CLI/MCP request semantics, Evidence provenance, target selection and lifecycle ownership. Do not add a native summary feature just to match inaccurate wording.
• Run relevant source/schema checks and real public CLI/MCP reproductions. Validate generated docs, rendering/anchors and regenerated notice coverage. Record unavailable Windows/macOS/licensed-provider coverage honestly.
• Keep heavy verification sequential with bounded CPU/memory and isolated client configuration. Do not edit root READMEs, translations, website docs or unrelated code.
• Address this issue in a reviewed PR, follow CI/review feedback to completion, and merge after the required checks pass.

The audit also noted ambiguous Hopper shutdown wording and an unverified macOS sleigh prerequisite. They are not part of the 12 confirmed fixes; uncertain behavior should not be changed without evidence.

Originally created by @N0zoM1z0 on GitHub (Oct 13, 2026). Original GitHub issue: https://github.com/morluto/rea/issues/2454 Originally assigned to: @N0zoM1z0 on GitHub. ## Problem A documentation/behavior audit at main `f254f5ac2b804b353a711264bb178f43fdf07867` confirmed the following 12 inconsistencies. Findings were checked against source owners and, where applicable, actual public CLI/SDK-connected stdio MCP workflows. Root READMEs/translations and `website/` are outside this work. ### Runtime contracts and tool guidance - [x] **D09: Harmony archive session outputs.** The domain recognizes `.hap`, `.hsp` and `.app` (`app-pack`), but the shared session output-format enum omits all three. Actual MCP `open_binary` and `binary_session` return output-validation errors even though the target becomes active and `inspect_artifact` succeeds. CLI inventory/projection succeeds. The Harmony verifier currently only submits CLI-produced Evidence to MCP projection and misses the opener/status journey. Fix the owning format contract and exercise the complete public lifecycle. - [x] **D12: Unsupported native summary recommendation.** The live `inspect_analysis_view` description recommends `view: {kind: "summary"}` for native function Evidence, while the native projector accepts `kind: "native"` facets. Actual current SDK calls reject summary and accept a procedure facet for the same authentic parent. Correct the description to match supported behavior. ### Documentation accuracy - [x] **D05:** `docs/installation.md` incorrectly groups Qoder, Trae, ZCode and Hermes under `~/.agents/skills`; isolated public setup dry-runs show dedicated client roots. Reuse the authoritative client configuration guide. - [x] **D02:** `docs/raw-binary.md` says Windows Ghidra P0 accepts PE applications only, although native PE DLLs are admitted too. - [x] **D06:** `docs/javascript-runtime-reconciliation.md` omits supported target-only partial `capture_electron_scenario` Evidence from its exclusive producer list. - [x] **D07:** The native/artifact skill reference says `extract_artifact` takes no arguments; it accepts optional `integrity_policy`, confirmed with real ZIP extraction. - [x] **D04:** The ADB guide says `am` is not exposed while fixed-vector app/activity lifecycle operations use `am start -W` and `am force-stop`. - [x] **D11:** `SECURITY.md` describes every owned provider bridge as a Unix socket, omitting Windows Ghidra's authenticated loopback TCP and private NTFS descriptor boundary. - [x] **D03:** The RISC-V guide calls RVE a 15-register ABI. RV32E/RV64E define 16 architectural GPRs, x0–x15, including the zero register. See the [official ISA](https://docs.riscv.org/reference/isa/unpriv/rv32e.html). - [x] **D01:** The managed guide's `#managednative-boundary-rules` link does not match installed VitePress's `#managed-native-boundary-rules` anchor. Preserve navigation in both repository and rendered docs. ### Records and operational prerequisites - [x] **D10:** License records claim complete locked dependency coverage but list 561 entries versus 586 in the audited lockfile, omitting 25 Frida-related optional runtime entries. `detect-libc` is also still classified as development; runtime notices lack a Frida entry. Refresh from the actual lockfile/archives and preserve upstream texts. This finding is a record-coverage gap, not a legal conclusion. - [x] **D08:** The release synchronization guide requires a PR merge commit, while the repository currently disables that merge method. Document the maintainer prerequisite and ancestry requirement without silently changing repository settings or substituting squash/rebase. ## Acceptance - Recheck every finding against updated main before editing; already-fixed items need verification rather than duplicate changes. - Correctness first; concise English guidance, shared rules maintained at their owning source, necessary limits and recovery steps retained. - Preserve CLI/MCP request semantics, Evidence provenance, target selection and lifecycle ownership. Do not add a native summary feature just to match inaccurate wording. - Run relevant source/schema checks and real public CLI/MCP reproductions. Validate generated docs, rendering/anchors and regenerated notice coverage. Record unavailable Windows/macOS/licensed-provider coverage honestly. - Keep heavy verification sequential with bounded CPU/memory and isolated client configuration. Do not edit root READMEs, translations, website docs or unrelated code. - Address this issue in a reviewed PR, follow CI/review feedback to completion, and merge after the required checks pass. The audit also noted ambiguous Hopper shutdown wording and an unverified macOS `sleigh` prerequisite. They are not part of the 12 confirmed fixes; uncertain behavior should not be changed without evidence.

bsakaguchi 2026-10-15 18:28:45 +00:00

• closed this issue
• added the
  bug
  label

bsakaguchi referenced this issue from rehan-remade/universal-modder 2026-10-15 20:53:50 +00:00

[PR #134] [MERGED] kb: reading old ForzaTech burG .modelbin containers and the MakeH2O lineage #150

bsakaguchi referenced this issue 2026-10-16 21:16:39 +00:00

[PR #840] [MERGED] fix(ghidra): admit the 12.1 line and the install's JDK range #2278

Sign in to join this conversation.

No Branch/Tag specified

Branches Tags

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   

area: bridge

  

area: bridge

  

area: build

  

area: build

  

area: build

  

area: cli

  

area: domain

  

area: evidence

  

area: mcp

  

area: native

  

area: providers

  

area: runtime

  

area: server

  

area: setup

  

area: tests

  

bug

  

design

  

documentation

  

enhancement

  

enhancement

  

enhancement

  

experiment

  

help wanted

  

i18n

  

invalid

  

P0: critical

  

P1: high

  

P2: medium

  

P2: medium

  

P2: medium

  

P3: low

  

performance

  

provider-request

  

pull-request

Mirrored from GitHub Pull Request

  

question

  

roadmap

  

triage

No labels

area: bridge

area: bridge

area: build

area: build

area: build

area: cli

area: domain

area: evidence

area: mcp

area: native

area: providers

area: runtime

area: server

area: setup

area: tests

bug

design

documentation

enhancement

enhancement

enhancement

experiment

help wanted

i18n

invalid

P0: critical

P1: high

P2: medium

P2: medium

P2: medium

P3: low

performance

provider-request

pull-request

question

roadmap

triage

Milestone

Clear milestone

No items

No milestone

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

1 participant

Notifications

Subscribe

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#821

No description provided.