red-harness-core 0.1.0__tar.gz

red_harness_core-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

red_harness_core-0.1.0/NOTICE

@@ -0,0 +1,6 @@
+Red Harness
+Copyright 2026 LiebertDev
+Licensed under Apache-2.0 (see LICENSE).
+
+Third-party tools that Red Harness can use are not bundled; their licences are listed in THIRD_PARTY_NOTICES.md and
+the upstream licence texts are in licenses/.

red_harness_core-0.1.0/PKG-INFO

@@ -0,0 +1,299 @@
+Metadata-Version: 2.4
+Name: red-harness-core
+Version: 0.1.0
+Summary: Red Harness: a defensive, evidence-bound reverse-engineering analysis harness
+Author: LiebertDev
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/LiebertDev/red-harness
+Project-URL: Source, https://github.com/LiebertDev/red-harness
+Project-URL: Issues, https://github.com/LiebertDev/red-harness/issues
+Project-URL: Changelog, https://github.com/LiebertDev/red-harness/blob/main/CHANGELOG.md
+Project-URL: Security, https://github.com/LiebertDev/red-harness/blob/main/SECURITY.md
+Keywords: reverse-engineering,mcp,ghidra,ida,static-analysis,security,evidence
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: Microsoft :: Windows :: Windows 10
+Classifier: Operating System :: Microsoft :: Windows :: Windows 11
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development :: Disassemblers
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+License-File: THIRD_PARTY_NOTICES.md
+License-File: licenses/README.md
+License-File: licenses/capstone-5.0.6-LICENSE.TXT
+License-File: licenses/cpython-3.12.10-LICENSE.txt
+License-File: licenses/ghidra-12.1.3-LICENSE.txt
+License-File: licenses/unicorn-2.1.4-COPYING.txt
+Requires-Dist: mcp==1.30.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: jsonschema>=4.20; extra == "dev"
+Provides-Extra: emulate
+Requires-Dist: unicorn==2.1.4; extra == "emulate"
+Dynamic: license-file
+
+# Red Harness
+
+An evidence-bound static reverse-engineering harness for binaries **you own or are authorized to test**.
+
+It is an MCP server (`rh mcp`, stdio) with 18 tools: static analysis through an IDA or Ghidra engine
+(functions, strings, xrefs, decompile, disassemble, raw byte and raw string reading), controlled execution in Windows Sandbox when the
+scope manifest allows it, a sandboxed `compute` tool for the model's own Python, and fix verification. Every claim a
+model records has to cite evidence ids, quotes and addresses; a claim verifier checks them against the
+evidence ledger and rejects or downgrades claims it cannot support. Behavior claims are proven only by a controlled run,
+not by a value appearing in code. Whatever was not examined is reported as unknown, never as "clean".
+
+Design notes are in `docs/design/`, the tool surface is in `docs/usage-mcp.md` and `docs/tool-design.md`, and the
+privacy rules for tracked files are in `docs/privacy-guard.md`. Third-party attributions: `NOTICE`; optional third-party components and their licences: `THIRD_PARTY_NOTICES.md`.
+
+## How is this different
+Tool-wrapper MCP servers give an agent reverse-engineering tools and pass the tool output through; nothing checks what the
+agent then says about the binary. Red Harness adds that check:
+- **Every claim is verified against recorded evidence.** A claim cites evidence ids, quotes and addresses. A deterministic
+  verifier (no model) re-checks each one against the evidence ledger and rejects or downgrades what the evidence does not
+  support. Every status and reason it can give is listed in [`docs/verifier-messages.md`](https://github.com/LiebertDev/red-harness/blob/main/docs/verifier-messages.md).
+- **Behavior is proven only by a run.** "This input is accepted" is never read off the code: it needs a controlled run of the
+  target, and static evidence alone leaves such a claim unverified.
+- **Targets run in Windows Sandbox.** Native execution of the target happens only there (network off, output records
+  authenticated), and only when the scope manifest allows it.
+- **Unexamined is unknown.** What was not looked at is reported as an unknown with its coverage, never as "clean".
+
+## Quickstart in 5 minutes
+Install the `red-harness-core` package (the command it installs is `rh`; Python 3.12 on Windows):
+```
+pipx install red-harness-core
+rh deps list                       # is Ghidra found? if not: rh deps show ghidra; it needs a JDK 21
+rh quickstart C:\Windows\System32\notepad.exe
+```
+From a checkout instead: `pipx install .` (or build a wheel with `python -m build --wheel` and install the file from `dist`).
+No model and no API key needed. `rh quickstart` checks the prerequisites, writes a scope manifest for the file (use a file you
+own or are authorized to analyse), opens it with Ghidra (else IDA), runs a small static pass through the same code path as the
+MCP tools, records two example claims that quote real evidence, builds the report and prints where it is, a short summary and
+how to connect Claude Code or another MCP client. The first open runs the engine's analysis once (133 s for notepad.exe with
+Ghidra 12.1.3 in our run); a repeat run is served from the cache (1 s).
+
+## Demo
+Real output of `rh quickstart C:\Windows\System32\notepad.exe --engine ghidra` (Ghidra 12.1.3, Windows 10; the data folder
+path is shown as `<DATA_ROOT>`):
+```
+Static pass with ghidra (the first open analyses the whole binary once; a cached result is reused later)
+  target_open     x86 64-bit, 498 functions, 557 strings, protection NO_KNOWN_INDICATORS (140s)
+  functions_list  498 functions, evidence ev_04e98a81e9b3894d
+  imports         301 symbols from 28 DLLs, evidence ev_7e00c8229285bd85
+  strings         100 of 557 returned, evidence ev_c01e6dbb5a5ea895
+  claim_add       SUPPORTED: The target imports GDI32.dll!CreateDCW at 0x140026800.
+  claim_add       SUPPORTED: The target contains the string Unknown exception at 0x1400273d0.
+
+Summary
+  target     notepad.exe, entry 0x140023bd0, sha256 da5807bb0997cc6b...
+  pe profile PE32+ x64 windows_gui 7 sections aslr=yes dep=yes cfg=yes
+  claims     2 recorded, 2 verified by the claim verifier
+  report     2 findings, 0 hypotheses, 0 unsupported claims in findings (must be 0)
+  coverage   NO_RECORDED_GAPS; not 'clean': functions listed 200/498, strings 100/557, nothing decompiled
+
+Report: <DATA_ROOT>\jobs\job_da5807bb0997cc6b\report\report-8d4209bf00e1cef1.md
+Total time: 142s
+```
+The generated report is in [`docs/examples/notepad-quickstart-report.md`](https://github.com/LiebertDev/red-harness/blob/main/docs/examples/notepad-quickstart-report.md); each claim
+cites evidence ids and quotes, and the coverage section lists what was not examined. [`docs/examples/README.md`](https://github.com/LiebertDev/red-harness/blob/main/docs/examples/README.md)
+explains each section.
+## Use from your agent
+One command registers the MCP server (the absolute path of the installed `rh`, with the engine it found) in the AI coding
+clients on this machine and installs the Red Harness skill, so your agent knows the evidence workflow:
+```
+rh setup --dry-run                 # shows what would change, with diffs; writes nothing
+rh setup                           # applies it; restart the client afterwards
+rh setup --client claude-code      # only one client: claude-code, codex, cursor, gemini, claude-desktop
+rh setup --print                   # only prints the configuration snippets, touches nothing
+rh setup --uninstall               # removes only the red-harness entry and the skill file it installed
+```
+Claude Code and Codex CLI are configured through their own `claude mcp add` / `codex mcp add`; Cursor
+(`~/.cursor/mcp.json`), Gemini CLI (`~/.gemini/settings.json`) and Claude Desktop (`claude_desktop_config.json`, classic or
+Microsoft Store install) through their JSON files, merged. The skill goes to `~/.claude/skills/red-harness/` (Claude Code) and
+`~/.agents/skills/red-harness/` (Codex CLI, Gemini CLI); `--no-skill` skips it. Every file is copied to
+`<name>.rh-backup-<timestamp>` before it changes, existing servers and settings are kept, and a second run changes nothing.
+A `red-harness` entry that does not run `rh mcp`, or a skill file you edited, is reported and left alone (`--force`
+overrides that).
+Then ask your agent, for example: "reverse engineer `C:\path\to\tool.exe`; I own it". Use only binaries you own or are
+authorized to test.
+
+## Editions
+This repository is the **Core** edition (Apache-2.0). **Pro** is a separate commercial edition. The MCP tool surface (18 tools)
+is the same in both; Pro adds capabilities behind the same tools and a few extra commands.
+
+| | Core (this repo, Apache-2.0) | Pro (commercial) |
+|---|---|---|
+| Static MCP tools (functions, strings, xrefs, decompile, disassemble, `read_bytes`, `file_strings`, `imports`) | yes | yes |
+| Evidence ledger, claim verifier, report | yes | yes |
+| Ghidra and IDA engines | yes | yes |
+| `run_controlled` and `compute` in Windows Sandbox | yes | yes |
+| Protection diagnosis (including vendor attribution) | yes | yes |
+| Check inventory (candidate protection / licensing checks in `target_open`) | yes | yes |
+| Dynamic observation (`run_controlled(observe=...)`: API trace, executable-memory digests) | no | yes |
+| Job bundle export and import (`rh export`, `rh import`) | no | yes |
+| Vendor audit pack (driver facts in `target_open`, driver/service/bundle/workspace triage scripts) | no | yes |
+| Evaluation and benchmark suite (`rh eval`, `rh bench`) | no | yes |
+| Kernel / Phase 2 lab | no | yes |
+| Studio UI | no | planned |
+
+In the Core build the Pro-only entry points answer in a fixed way: `run_controlled` with `observe` returns
+`DYNAMIC_BACKEND_UNAVAILABLE` ("premium feature not included in this build"), the Pro CLI commands print a premium notice and
+exit with status 2, and the driver facts in `target_open` are `{"available": false, "note": "premium feature not included in this build"}`.
+To ask about Pro: open a thread in [GitHub Discussions](https://github.com/LiebertDev/red-harness/discussions).
+
+## Requirements
+- **Windows 10 or 11, 64-bit** (developed and tested on Windows 10 Pro). The server, the engines and every static tool run
+  on any edition.
+- **Python 3.12** (`py -3.12`). The only runtime dependency is the `mcp` SDK, pinned and installed by pip.
+- **One analysis engine: Ghidra (free) or IDA Pro** (see "Engines"). No MCP tool works without an engine, because
+  `target_open` opens the target through it.
+- **Windows Sandbox, only for the two tools that execute the target natively or run model code** (`run_controlled` and
+  `compute`). Windows Sandbox is part of Windows 10/11 **Pro, Enterprise and Education** (not Home); it needs hardware
+  virtualization enabled in the firmware and the optional Windows feature "Windows Sandbox" switched on (restart
+  required). Without it those two tools return `SANDBOX_UNAVAILABLE` and everything else keeps working. The sandbox gets
+  2048 MB of memory by default (`RH_SANDBOX_MEMORY_MB`, 512 to 16384). `emulate` also executes target code, but in a CPU
+  emulator inside a restricted host process, not in Windows Sandbox; it is off by default.
+  - `compute` also needs a pinned embeddable CPython, installed once: `rh compute-runtime` prints the download address and the
+    expected SHA-256, then `rh compute-runtime install python-3.12.10-embed-amd64.zip`.
+- Memory: the Ghidra engine runs a JVM with a 4 GB heap (6 GB job limit); the IDA engine is limited to 6 GB as well.
+
+## Optional components
+Red Harness bundles **no** third-party engine or library. The optional pieces are obtained by you, from their own
+publishers, under their own licences, and none of them is covered by Red Harness's Apache-2.0 licence:
+Unicorn (`emulate`), Capstone, Ghidra, IDA Pro/Home, the CPython embeddable package for `compute`, and Windows Sandbox.
+See `THIRD_PARTY_NOTICES.md` (what each is for, how to get it, its licence and upstream link) and `licenses/README.md`.
+
+`rh deps list` shows each component, whether it is present, its licence and its upstream link. `rh deps install emulate`
+(or `capstone`) prints the licence notice, asks for confirmation (`--yes` skips the question) and then runs
+`pip install` for the pinned version; it installs nothing else. Ghidra and IDA are never installed by `rh`: `rh deps show ghidra`
+prints where to get them and which environment variable points Red Harness at them.
+
+## Engines
+Every MCP tool needs an analysis engine; choose one with `rh mcp --engine ghidra` or `rh mcp --engine ida`. Without the flag
+the server starts the IDA engine. A requested engine that is not usable stops the server with the reason on stderr and in the
+error answer to the client's `initialize` request; there is no silent fallback to the other engine.
+
+**Ghidra (free).**
+1. Ghidra 12.1.3 (the version this project is tested with): download the zip from
+   <https://github.com/NationalSecurityAgency/ghidra/releases> and extract it anywhere.
+2. A JDK 21 (for example Eclipse Temurin 21), with `java` on `PATH` or `JAVA_HOME` set. Check with `java -version` in a new terminal.
+3. Tell the server where Ghidra is: set `RH_GHIDRA_DIR` (or `GHIDRA_INSTALL_DIR`) to the extracted folder, the one that
+   contains `support\analyzeHeadless.bat`. Without either variable the server looks for `ghidra_*` on your Desktop, for `ghidra*` in
+   your user folder and in `%ProgramFiles%`, and for `C:\ghidra*` (newest name first).
+4. Start the server with `rh mcp --engine ghidra`. The first open of a target runs Ghidra's full analysis once (minutes for a
+   large binary; about two and a half minutes for a 200 KB system program on a desktop PC); the result is cached under the data
+   root and later opens and queries reuse it.
+
+**IDA.** IDA 9.x with a licence that includes `idalib` (IDA's headless library): the Pro editions. IDA Home and Classroom are listed by Hex-Rays as shipping idalib since 9.4; not yet tested by us. The Python package `idapro` that
+talks to it is deliberately not a dependency of this project (its publisher on PyPI is unverified); install it from the wheel in
+your IDA installation into the same environment as `red-harness-core`:
+```
+.venv\Scripts\pip install "<IDA>\idalib\python\idapro-0.0.9-py3-none-any.whl"
+```
+(With a `pipx` install: `pipx inject red-harness-core "<IDA>\idalib\python\idapro-0.0.9-py3-none-any.whl"`.)
+`<IDA>` is for example `C:\Program Files\IDA Professional 9.4`. Use the exact file name you find in that folder (`dir "<IDA>\idalib\python"`);
+pip does not accept a `*` wildcard there. Do not run `py-activate-idalib.py`. The IDA folder is found automatically under
+`%ProgramFiles%\IDA Professional*` or from `RH_IDA_DIR` / `IDADIR`. The engine runs IDA in a separate Python process; if that
+Python is not the one with `idapro`, set `RH_IDA_PYTHON` to it. Without `idapro`, `target_open` fails with `TOOL_MISSING` and
+a message that says exactly this.
+
+**What works without any engine:** none of the 18 MCP tools. The standalone scripts in `scripts/` need no engine and execute
+nothing (see "Standalone static CLIs"), and so does `rh compute-runtime`.
+
+## Quickstart
+This walk-through uses Ghidra and runs the same calls a model makes, from a small Python client that ships with the project.
+Use a program you built or are authorized to analyze; below it is `C:\path\to\target.exe`.
+```
+py -3.12 -m venv .venv
+.venv\Scripts\pip install -e .
+set RH_GHIDRA_DIR=C:\path\to\ghidra_12.1.3_PUBLIC
+```
+(`set` is for cmd.exe; in PowerShell use `$env:RH_GHIDRA_DIR = "C:\path\to\ghidra_12.1.3_PUBLIC"`. Skip it if Ghidra sits in one
+of the folders listed under "Engines".)
+1. SHA-256 of the target, lowercase (the manifest rejects upper case):
+   ```
+   powershell -NoProfile -Command "(Get-FileHash 'C:\path\to\target.exe' -Algorithm SHA256).Hash.ToLower()"
+   ```
+2. Write the scope manifest `scope.json` next to it. The hash binds the manifest to this exact file; `basis` is `owner` or
+   `authorized-test`; `allowed_operations` lists what the session may do (`static` is the minimum; `run_controlled` and
+   `compute` must be added explicitly); an optional `"expires": "2027-12-31"` limits its lifetime.
+   ```json
+   {
+     "schema": "rh.scope/1",
+     "target_sha256": "<the lowercase hash from step 1>",
+     "authorization": {
+       "declared_by": "Your Name / Your Company",
+       "basis": "owner",
+       "statement": "This binary belongs to us; static analysis is authorized."
+     },
+     "allowed_operations": ["static"]
+   }
+   ```
+3. Run the client (first open: Ghidra analyses the target once):
+   ```
+   .venv\Scripts\python scripts\quickstart_client.py C:\path\to\target.exe scope.json --engine ghidra
+   ```
+   It starts `rh mcp --engine ghidra`, lists the tools and makes five calls: `target_open(target_path, manifest_path)`,
+   `strings(limit=20, detail="full")`, `claim_add(kind="observation", text, evidence_ids, atoms)` quoting the first string it got
+   back, `coverage()` and `report_build()`. It ends with the path of the Markdown report, under
+   `<data root>\jobs\<job id>\report\`. A model client makes exactly these calls with the arguments named above; the
+   `claim_add` atoms are `{"type":"quote","evidence_id":"ev_...","text":"<string>"}` and
+   `{"type":"address","evidence_id":"ev_...","value":"0x..."}`.
+
+## Connect an MCP client
+Use absolute paths. The server needs the engine settings in its environment.
+
+Claude Code: copy `.mcp.json.example` to `.mcp.json` in your project folder, replace the placeholder paths, start Claude Code and
+approve the `red-harness` server with `/mcp`.
+```json
+{
+  "mcpServers": {
+    "red-harness": {
+      "type": "stdio",
+      "command": "C:\\path\\to\\red-harness\\.venv\\Scripts\\rh.exe",
+      "args": ["mcp", "--engine", "ghidra"],
+      "env": {"RH_GHIDRA_DIR": "C:\\path\\to\\ghidra_12.1.3_PUBLIC", "RH_DATA_ROOT": "C:\\path\\to\\RedHarnessData"}
+    }
+  }
+}
+```
+OpenAI Codex CLI (`~/.codex/config.toml`):
+```toml
+[mcp_servers.red-harness]
+command = 'C:\path\to\red-harness\.venv\Scripts\rh.exe'
+args = ["mcp", "--engine", "ghidra"]
+env = { RH_GHIDRA_DIR = 'C:\path\to\ghidra_12.1.3_PUBLIC', RH_DATA_ROOT = 'C:\path\to\RedHarnessData' }
+```
+Any other stdio MCP client: run the command `C:\path\to\red-harness\.venv\Scripts\rh.exe` with the arguments `mcp --engine ghidra`
+and the environment variables above. The protocol runs over the process's stdin and stdout (one JSON-RPC message per line), so
+nothing else may write to stdout. `scripts/quickstart_client.py` is a complete example client built on the official `mcp` SDK.
+The server side was verified with that SDK client; the client entries above follow those clients' documented formats.
+
+If a client only says "connection closed", start the same command in a terminal: the reason is printed on stderr.
+
+## Development and tests
+Install with the test extra and run the default suite (no engine and no Windows Sandbox needed):
+```
+py -3.12 -m venv .venv
+.venv\Scripts\pip install -e .[dev]
+.venv\Scripts\python -m pytest -m "not heavy"
+```
+- `heavy` tests need a real Ghidra/IDA or Windows Sandbox; they are not part of the default run.
+- Unit tests point `RH_DATA_ROOT` at a temp directory; `RedHarnessData` or any other directory need not exist beforehand.
+- Real Windows Sandbox tests run only with `RH_ALLOW_REAL_SANDBOX=1` (otherwise skipped).
+- Engine paths and the `idapro` install are described under "Engines" above and in `docs/usage-mcp.md`.
+
+## Standalone static CLIs
+Read-only helper in `scripts/` that needs no engine, no Windows Sandbox and executes nothing: `file_strings.py` (it prints its usage in its module docstring).
+
+## Scope
+Use it only on targets you own or are explicitly authorized to test. The scope manifest is required, binds the target
+SHA-256 and lists the effects (for example `run_controlled`, `compute`) a session may use.