Files
rea/src/server/registerGdbTools.ts
T
4aa51bfe19 fix(reverse): reconcile cleanup ownership and mutation diagnostics (#2799)
* feat(process): add owned debugger shutdown lifecycle

* feat(reverse): add local inspection commands

* feat(gdb): add persistent debugger integration

* feat(cutter): add Cutter bridge integration

* test(reverse): enforce complete integration coverage

* fix(process): preserve debugger shutdown ownership

* fix(reverse): retain evidence across interrupted commands

* fix(gdb): honor captured provider environment

* test(process): cover debugger shutdown retries

* fix(reverse): retain evidence for interrupted providers

* test(process): cover debugger shutdown retries

* fix(reverse): retain evidence for interrupted providers

* fix(server): snapshot provider environment at creation

* fix(reverse): close review gaps with complete coverage

* fix(reverse): address inspection review findings

* fix(gdb): bound sessions and retain cleanup ownership

* fix(ci): require reverse-tools quality lane

* fix(process): unref inherited debugger output pipes

* fix(reverse): address remaining PR 1960 findings

* fix(gdb): address remaining PR 1961 findings

* fix(reverse): account for unrestricted provider execution

* fix(process): retain debugger ownership until safe shutdown

* fix(process): preserve replacement debugger sessions

* fix(reverse): preserve admission and output provenance

* fix(process): retain exited debugger until output settles

* fix(mcp): bound provider admission and debugger cleanup

* fix(reverse): preserve failure provenance and classify E2BIG

* fix(gdb): preserve startup cleanup and detach safety

* fix(process): retain debugger ownership after detach failure

* fix(reverse): preserve mutation and failure provenance

* fix(gdb): address debugger review findings

* fix(reverse): rebind sessions after external mutation

* fix(process): cap debugger output after exit

* fix(gdb): protect one-shot detach verification

* feat(debugger): add reverse tool coverage gate

* test(debugger): cover integrated failure paths

* fix(gdb): bound and preserve session observations

* fix(gdb): address review regressions

* style: format merged integration files

* fix(reverse): preserve session and output evidence

* refactor(gdb): share repeated test and partial result setup

* fix(gdb): invalidate TTY proof for Python aliases

* fix(reverse): retain failure output byte counts

* test(process): synchronize late debugger output

* fix(gdb): invalidate TTY proof for wrapped commands

* fix(gdb): recognize wit command abbreviation

* test(reverse): wait for cancelled descendant readiness

* test(reverse): bound descendant cancellation cleanup

* style(reverse): format integration tests and adapters

* style: format reverse engineering integration files

* test(reverse): remove duplicate environment harness

* test(gdb): share session startup assertions

* fix(gdb): invalidate output proof for command abbreviations

* test(reverse): share composition edge case scenarios

* fix(ci): recognize verification and mutation tool entries

* test(rizin): cover successful fake inferior detach

* test(cli): align full output failure envelope

* test(cli): isolate reverse command lifecycle service

* test(process): share debugger output fixture setup

* fix(binary): preserve high-bit Windows signature bytes

* style(binary): format Windows signature parser

* test(mcp): preserve call coverage in unchanged comparison

* fix(ci): include reverse tools Vitest configs in lint cache

* fix(mcp): preserve target content on delivery errors

* ci: align duplication ceiling with expanded suite

* test(reverse): allow signal admission mutants

* fix(reverse): bound retained cleanup failures to process owners

* fix(test): replace drifting mutation ranges with owned selectors

* fix(reverse): admit persistent commands and retain cleanup ownership

* fix(cutter): recover timed-out commands from exact receipts

* fix(cutter): reject unsupported bridge request kinds

* fix(ci): repair client format and shared verification fixtures

* fix(native): preserve debugger cleanup ownership and bridge authentication

* test(native): retain diagnostics without perfect coverage requirements

* chore(licenses): refresh locked dependency inventory and notices

* fix(test): exclude transient command locks from mutation sandboxes

* fix(gdb): admit only platforms with safe detach verification

* fix(cutter): retain bounded completion receipts until acknowledgement

* fix(cutter): acknowledge commands rejected before UI dispatch

* test(reverse): fail cancellation checks before fixture teardown

* test(gdb): clean up the retained broken-stdin fixture owner

* docs(test): clarify focused provider verification scope

* fix(rizin): retain close cleanup failures

* fix(gdb): wait for inferior stop and bound MI buffering

* fix(cutter): retain failed receipt acknowledgements

* fix(rizin): return retained session identity on rebind failure

* fix(gdb): preserve startup cancellation and lossy status

* fix(rizin): retain launch provenance and assemble frames once

* fix(cutter): recover receipts across callers and bound discovery

* docs: describe debugger evidence and bridge recovery

* fix(process): keep cleanup incomplete while writers remain

Stopping a debugger no longer reports success when inherited output
streams stay open, so BinarySession cannot reopen a binary a child is
still changing. Concurrent Cutter cleanup retries share one receipt
acknowledgement instead of treating a consumed receipt as failure.

* fix(debuggers): recover cleanup with captured process identities

* fix(analysis): retire sessions after unrestricted commands

* fix(cli): preserve completed evidence after cleanup recovery

* fix(cutter): bound frame collection and coalesce cleanup

* fix(windows): resolve selected provider paths absolutely

* fix(gdb): report decoding loss in failed startup evidence

* fix(rizin): scope decoding loss to collected command frames

* test(mcp): cover snapshot retirement in reverse tools CI

---------

Co-authored-by: Daniel Gonçalves Araujo <[email protected]>
Co-authored-by: REA Maintainers <[email protected]>
Co-authored-by: OpenAI Codex <[email protected]>
Co-authored-by: Cursor Agent <[email protected]>
2026-10-14 04:47:34 +08:00

157 lines
5.1 KiB
TypeScript

import type { McpServer, ServerContext } from "@modelcontextprotocol/server";
import type { Logger } from "pino";
import type { GdbSessionManager } from "../gdb/GdbSessionManager.js";
import type { EvidenceWriter } from "../application/investigation/InvestigationRecordPort.js";
import { toolContract } from "../contracts/toolContracts.js";
import { evidenceSchema } from "../domain/evidence.js";
import { err } from "../domain/result.js";
import { AnalysisInputError } from "../domain/analysisErrorCore.js";
import {
runOwnedCleanupWithExternalMutationAdmission,
runWithExternalMutationAdmission,
type ExternalMutationAdmission,
} from "./externalMutationAdmission.js";
import { logToolExecution } from "./toolLogging.js";
import { toolRegistrationOptions } from "./toolRegistrationOptions.js";
import type { ToolResultDelivery } from "./toolResult.js";
export type GdbToolManager = Pick<
GdbSessionManager,
"start" | "execute" | "status" | "close" | "retryCleanupFailures"
>;
/** Register persistent GDB session operations on the existing REA MCP server. */
export const registerGdbTools = (
server: McpServer,
manager: GdbToolManager,
logger: Logger,
delivery: ToolResultDelivery,
recordEvidence?: EvidenceWriter["recordEvidence"],
session?: ExternalMutationAdmission,
): void => {
const start = toolContract("start_gdb_session");
const consoleContract = toolContract("gdb_console");
const status = toolContract("gdb_session_status");
const close = toolContract("close_gdb_session");
server.registerTool(
start.name,
toolRegistrationOptions(start),
async (input, context: ServerContext) => {
const result = await logToolExecution(logger, start.name, () =>
manager.start(
context.mcpReq.signal,
input.inferior_tty === undefined
? {}
: { inferiorTty: input.inferior_tty },
),
);
if (result.ok)
return delivery.toCallToolResult(
{ ok: true, value: result.value },
start,
);
const partial = result.error.partialObservation;
const parsed = evidenceSchema.safeParse(partial);
if (parsed.success) {
const recorded = recordEvidence?.(parsed.data);
if (recorded !== undefined)
return delivery.toRecordedPartialErrorToolResult(
result.error,
parsed.data.evidence_id,
recorded,
start.returnsTargetContent,
);
}
return delivery.toCallToolResult(result, start);
},
);
server.registerTool(
consoleContract.name,
toolRegistrationOptions(consoleContract),
async (input, context: ServerContext) => {
const execute = () =>
logToolExecution(logger, consoleContract.name, () =>
manager.execute(
input.session_id,
input.command,
context.mcpReq.signal,
),
);
const result = await runWithExternalMutationAdmission(
session,
consoleContract.name,
context.mcpReq.signal,
execute,
(value) => value.evidence,
() => manager.retryCleanupFailures(),
);
if (!result.ok) {
const partial = result.error.partialObservation;
const parsed = evidenceSchema.safeParse(partial);
if (parsed.success) {
const recorded = recordEvidence?.(parsed.data);
if (recorded !== undefined)
return delivery.toRecordedPartialErrorToolResult(
result.error,
parsed.data.evidence_id,
recorded,
consoleContract.returnsTargetContent,
);
}
return delivery.toCallToolResult(result, consoleContract);
}
const recorded = recordEvidence?.(result.value.evidence);
return delivery.toEvidenceToolResult(
result.value.evidence,
consoleContract,
recorded,
);
},
);
server.registerTool(
status.name,
toolRegistrationOptions(status),
async (input) => {
const result = manager.status(input.session_id);
if (result === undefined)
return delivery.toCallToolResult(
err(invalidSession("gdb_session_status")),
status,
);
return delivery.toCallToolResult(
{
ok: true,
value: {
...result,
recent_mi_records: [...result.recent_mi_records],
},
},
status,
);
},
);
server.registerTool(
close.name,
toolRegistrationOptions(close),
async (input, context: ServerContext) => {
const result = await runOwnedCleanupWithExternalMutationAdmission(
session,
close.name,
context.mcpReq.signal,
input.session_id,
() =>
logToolExecution(logger, close.name, () =>
manager.close(input.session_id),
),
);
return result.ok
? delivery.toCallToolResult({ ok: true, value: result.value }, close)
: delivery.toCallToolResult(result, close);
},
);
};
const invalidSession = (operation: string): AnalysisInputError =>
new AnalysisInputError(operation);