windows-exe-decompiler-mcp-server 0.1.0 → 0.1.3

package/dist/setup-guidance.d.ts

@@ -0,0 +1,73 @@
+import { z } from 'zod';
+import type { WorkerResult } from './types.js';
+export declare const SetupActionSchema: z.ZodObject<{
+    id: z.ZodString;
+    required: z.ZodBoolean;
+    kind: z.ZodEnum<["pip_install", "set_env", "provide_path", "verify_install"]>;
+    title: z.ZodString;
+    summary: z.ZodString;
+    command: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    env_var: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    value_hint: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    examples: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+    applies_to: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    summary: string;
+    kind: "pip_install" | "set_env" | "provide_path" | "verify_install";
+    title: string;
+    required: boolean;
+    examples: string[];
+    applies_to: string[];
+    command?: string | null | undefined;
+    env_var?: string | null | undefined;
+    value_hint?: string | null | undefined;
+}, {
+    id: string;
+    summary: string;
+    kind: "pip_install" | "set_env" | "provide_path" | "verify_install";
+    title: string;
+    required: boolean;
+    command?: string | null | undefined;
+    env_var?: string | null | undefined;
+    value_hint?: string | null | undefined;
+    examples?: string[] | undefined;
+    applies_to?: string[] | undefined;
+}>;
+export declare const RequiredUserInputSchema: z.ZodObject<{
+    key: z.ZodString;
+    label: z.ZodString;
+    summary: z.ZodString;
+    required: z.ZodBoolean;
+    env_vars: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+    examples: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+}, "strip", z.ZodTypeAny, {
+    summary: string;
+    label: string;
+    required: boolean;
+    examples: string[];
+    key: string;
+    env_vars: string[];
+}, {
+    summary: string;
+    label: string;
+    required: boolean;
+    key: string;
+    examples?: string[] | undefined;
+    env_vars?: string[] | undefined;
+}>;
+export type SetupAction = z.infer<typeof SetupActionSchema>;
+export type RequiredUserInput = z.infer<typeof RequiredUserInputSchema>;
+export declare function mergeSetupActions(...groups: SetupAction[][]): SetupAction[];
+export declare function mergeRequiredUserInputs(...groups: RequiredUserInput[][]): RequiredUserInput[];
+export declare function buildBaselinePythonSetupActions(): SetupAction[];
+export declare function buildDynamicDependencySetupActions(): SetupAction[];
+export declare function buildPyGhidraSetupActions(): SetupAction[];
+export declare function buildGhidraRequiredUserInputs(): RequiredUserInput[];
+export declare function buildGhidraSetupActions(): SetupAction[];
+export declare function buildAllSetupActions(includeOptional?: boolean): SetupAction[];
+export declare function collectSetupGuidanceFromWorkerResult(result?: WorkerResult | null): {
+    setupActions: SetupAction[];
+    requiredUserInputs: RequiredUserInput[];
+};
+//# sourceMappingURL=setup-guidance.d.ts.map

package/dist/setup-guidance.js

@@ -0,0 +1,211 @@
+import { z } from 'zod';
+export const SetupActionSchema = z.object({
+    id: z.string(),
+    required: z.boolean(),
+    kind: z.enum(['pip_install', 'set_env', 'provide_path', 'verify_install']),
+    title: z.string(),
+    summary: z.string(),
+    command: z.string().nullable().optional(),
+    env_var: z.string().nullable().optional(),
+    value_hint: z.string().nullable().optional(),
+    examples: z.array(z.string()).default([]),
+    applies_to: z.array(z.string()).default([]),
+});
+export const RequiredUserInputSchema = z.object({
+    key: z.string(),
+    label: z.string(),
+    summary: z.string(),
+    required: z.boolean(),
+    env_vars: z.array(z.string()).default([]),
+    examples: z.array(z.string()).default([]),
+});
+const WINDOWS_GHIDRA_EXAMPLES = [
+    'C:\\Users\\<user>\\Downloads\\ghidra_12.0.4_PUBLIC',
+    'D:\\tools\\ghidra_12.0.4_PUBLIC',
+];
+export function mergeSetupActions(...groups) {
+    const merged = new Map();
+    for (const group of groups) {
+        for (const action of group) {
+            merged.set(action.id, action);
+        }
+    }
+    return [...merged.values()];
+}
+export function mergeRequiredUserInputs(...groups) {
+    const merged = new Map();
+    for (const group of groups) {
+        for (const input of group) {
+            merged.set(input.key, input);
+        }
+    }
+    return [...merged.values()];
+}
+export function buildBaselinePythonSetupActions() {
+    return [
+        {
+            id: 'install_python_requirements',
+            required: true,
+            kind: 'pip_install',
+            title: 'Install baseline Python dependencies',
+            summary: 'Install the baseline static-analysis Python packages before using worker-backed analysis tools.',
+            command: 'python -m pip install -r requirements.txt',
+            examples: ['python -m pip install -r requirements.txt'],
+            applies_to: ['system.health', 'dynamic.dependencies', 'static-analysis'],
+        },
+    ];
+}
+export function buildDynamicDependencySetupActions() {
+    return [
+        {
+            id: 'install_dynamic_requirements',
+            required: false,
+            kind: 'pip_install',
+            title: 'Install dynamic-analysis extras',
+            summary: 'Install the optional dynamic-analysis package set used by Speakeasy, Frida, and process telemetry probes.',
+            command: 'python -m pip install -r workers/requirements-dynamic.txt',
+            examples: ['python -m pip install -r workers/requirements-dynamic.txt'],
+            applies_to: ['dynamic.dependencies', 'sandbox.execute'],
+        },
+        {
+            id: 'install_speakeasy_emulator',
+            required: false,
+            kind: 'pip_install',
+            title: 'Install Speakeasy emulator',
+            summary: 'Install FLARE Speakeasy for user-mode PE emulation.',
+            command: 'python -m pip install speakeasy-emulator',
+            examples: ['python -m pip install speakeasy-emulator'],
+            applies_to: ['dynamic.dependencies', 'sandbox.execute'],
+        },
+        {
+            id: 'install_frida',
+            required: false,
+            kind: 'pip_install',
+            title: 'Install Frida runtime tracing',
+            summary: 'Install Frida when you need live instrumentation or API tracing support.',
+            command: 'python -m pip install frida',
+            examples: ['python -m pip install frida'],
+            applies_to: ['dynamic.dependencies'],
+        },
+        {
+            id: 'install_psutil',
+            required: false,
+            kind: 'pip_install',
+            title: 'Install psutil process telemetry',
+            summary: 'Install psutil for process metadata and lightweight telemetry probes.',
+            command: 'python -m pip install psutil',
+            examples: ['python -m pip install psutil'],
+            applies_to: ['dynamic.dependencies'],
+        },
+    ];
+}
+export function buildPyGhidraSetupActions() {
+    return [
+        {
+            id: 'install_pyghidra',
+            required: false,
+            kind: 'pip_install',
+            title: 'Install PyGhidra',
+            summary: 'Install PyGhidra in the active Python environment to improve Ghidra post-script compatibility.',
+            command: 'python -m pip install pyghidra',
+            examples: ['python -m pip install pyghidra'],
+            applies_to: ['ghidra.health', 'ghidra.analyze', 'system.health'],
+        },
+    ];
+}
+export function buildGhidraRequiredUserInputs() {
+    return [
+        {
+            key: 'ghidra_install_dir',
+            label: 'Ghidra install root',
+            summary: 'Provide the absolute path to the Ghidra installation root. This is the directory that contains support\\analyzeHeadless.bat.',
+            required: true,
+            env_vars: ['GHIDRA_PATH', 'GHIDRA_INSTALL_DIR'],
+            examples: WINDOWS_GHIDRA_EXAMPLES,
+        },
+    ];
+}
+export function buildGhidraSetupActions() {
+    return [
+        {
+            id: 'set_ghidra_path',
+            required: true,
+            kind: 'set_env',
+            title: 'Set GHIDRA_PATH',
+            summary: 'Set GHIDRA_PATH to the Ghidra installation root so the server can find support\\analyzeHeadless.bat.',
+            env_var: 'GHIDRA_PATH',
+            value_hint: 'Absolute path to the Ghidra installation root directory',
+            examples: WINDOWS_GHIDRA_EXAMPLES.map((example) => `$env:GHIDRA_PATH = "${example}"`),
+            applies_to: ['ghidra.health', 'ghidra.analyze', 'system.health'],
+        },
+        {
+            id: 'set_ghidra_install_dir',
+            required: false,
+            kind: 'set_env',
+            title: 'Set GHIDRA_INSTALL_DIR',
+            summary: 'As an alternative to GHIDRA_PATH, set GHIDRA_INSTALL_DIR to the same Ghidra installation root.',
+            env_var: 'GHIDRA_INSTALL_DIR',
+            value_hint: 'Absolute path to the Ghidra installation root directory',
+            examples: WINDOWS_GHIDRA_EXAMPLES.map((example) => `$env:GHIDRA_INSTALL_DIR = "${example}"`),
+            applies_to: ['ghidra.health', 'ghidra.analyze', 'system.health'],
+        },
+        {
+            id: 'verify_ghidra_install_layout',
+            required: true,
+            kind: 'verify_install',
+            title: 'Verify Ghidra install layout',
+            summary: 'Confirm the configured directory contains support\\analyzeHeadless.bat. Do not point GHIDRA_PATH at the support subdirectory itself.',
+            examples: WINDOWS_GHIDRA_EXAMPLES.map((example) => `${example}\\support\\analyzeHeadless.bat`),
+            applies_to: ['ghidra.health', 'ghidra.analyze'],
+        },
+    ];
+}
+export function buildAllSetupActions(includeOptional = true) {
+    return mergeSetupActions(buildBaselinePythonSetupActions(), buildDynamicDependencySetupActions(), buildGhidraSetupActions(), includeOptional ? buildPyGhidraSetupActions() : []);
+}
+function inferSetupGuidanceFromMessages(messages) {
+    const combined = messages.join('\n');
+    let setupActions = [];
+    let requiredUserInputs = [];
+    if (/ghidra|analyzeheadless|project_.*ghidra|support\\analyzeHeadless/i.test(combined)) {
+        setupActions = mergeSetupActions(setupActions, buildGhidraSetupActions());
+        requiredUserInputs = mergeRequiredUserInputs(requiredUserInputs, buildGhidraRequiredUserInputs());
+    }
+    if (/pyghidra/i.test(combined)) {
+        setupActions = mergeSetupActions(setupActions, buildPyGhidraSetupActions());
+    }
+    if (/python worker|module not found|modulenotfounderror|no module named|yara-python|flare-floss|speakeasy|frida|psutil|pip install/i.test(combined)) {
+        setupActions = mergeSetupActions(setupActions, buildBaselinePythonSetupActions());
+        if (/speakeasy|frida|psutil/i.test(combined)) {
+            setupActions = mergeSetupActions(setupActions, buildDynamicDependencySetupActions());
+        }
+    }
+    return {
+        setupActions,
+        requiredUserInputs,
+    };
+}
+export function collectSetupGuidanceFromWorkerResult(result) {
+    if (!result) {
+        return {
+            setupActions: [],
+            requiredUserInputs: [],
+        };
+    }
+    const data = result.data && typeof result.data === 'object' ? result.data : {};
+    const setupActions = Array.isArray(data.setup_actions)
+        ? data.setup_actions.filter(Boolean).map((item) => SetupActionSchema.parse(item))
+        : [];
+    const requiredUserInputs = Array.isArray(data.required_user_inputs)
+        ? data.required_user_inputs.filter(Boolean).map((item) => RequiredUserInputSchema.parse(item))
+        : [];
+    const inferred = inferSetupGuidanceFromMessages([
+        ...(result.errors || []),
+        ...(result.warnings || []),
+    ]);
+    return {
+        setupActions: mergeSetupActions(setupActions, inferred.setupActions),
+        requiredUserInputs: mergeRequiredUserInputs(requiredUserInputs, inferred.requiredUserInputs),
+    };
+}
+//# sourceMappingURL=setup-guidance.js.map

package/dist/tools/artifact-read.d.ts

@@ -24,11 +24,11 @@ export declare const ArtifactReadInputSchema: z.ZodObject<{
     sample_id: string;
     recursive: boolean;
     encoding: "utf8" | "base64" | "auto";
+    max_bytes: number;
     include_untracked_files: boolean;
     scan_roots: string[];
     select_latest: boolean;
     include_content: boolean;
-    max_bytes: number;
     parse_json: boolean;
     ioc_highlights: boolean;
     path?: string | undefined;
@@ -39,13 +39,13 @@ export declare const ArtifactReadInputSchema: z.ZodObject<{
     path?: string | undefined;
     recursive?: boolean | undefined;
     encoding?: "utf8" | "base64" | "auto" | undefined;
+    max_bytes?: number | undefined;
     artifact_id?: string | undefined;
     artifact_type?: string | undefined;
     include_untracked_files?: boolean | undefined;
     scan_roots?: string[] | undefined;
     select_latest?: boolean | undefined;
     include_content?: boolean | undefined;
-    max_bytes?: number | undefined;
     parse_json?: boolean | undefined;
     ioc_highlights?: boolean | undefined;
 }>;
@@ -165,10 +165,6 @@ export declare const ArtifactReadOutputSchema: z.ZodObject<{
     }>>;
 }, "strip", z.ZodTypeAny, {
     ok: boolean;
-    metrics?: {
-        elapsed_ms: number;
-        tool: string;
-    } | undefined;
     data?: {
         sample_id: string;
         artifact: {
@@ -194,14 +190,14 @@ export declare const ArtifactReadOutputSchema: z.ZodObject<{
             pipes?: string[] | undefined;
         } | undefined;
     } | undefined;
-    warnings?: string[] | undefined;
-    errors?: string[] | undefined;
-}, {
-    ok: boolean;
     metrics?: {
         elapsed_ms: number;
         tool: string;
     } | undefined;
+    warnings?: string[] | undefined;
+    errors?: string[] | undefined;
+}, {
+    ok: boolean;
     data?: {
         sample_id: string;
         artifact: {
@@ -227,6 +223,10 @@ export declare const ArtifactReadOutputSchema: z.ZodObject<{
             pipes?: string[] | undefined;
         } | undefined;
     } | undefined;
+    metrics?: {
+        elapsed_ms: number;
+        tool: string;
+    } | undefined;
     warnings?: string[] | undefined;
     errors?: string[] | undefined;
 }>;

package/dist/tools/artifacts-diff.d.ts

@@ -538,10 +538,6 @@ export declare const artifactsDiffOutputSchema: z.ZodObject<{
     }>>;
 }, "strip", z.ZodTypeAny, {
     ok: boolean;
-    metrics?: {
-        elapsed_ms: number;
-        tool: string;
-    } | undefined;
     data?: {
         sample_id: string;
         summary: {
@@ -627,14 +623,14 @@ export declare const artifactsDiffOutputSchema: z.ZodObject<{
         }[];
         unchanged_count: number;
     } | undefined;
-    warnings?: string[] | undefined;
-    errors?: string[] | undefined;
-}, {
-    ok: boolean;
     metrics?: {
         elapsed_ms: number;
         tool: string;
     } | undefined;
+    warnings?: string[] | undefined;
+    errors?: string[] | undefined;
+}, {
+    ok: boolean;
     data?: {
         sample_id: string;
         summary: {
@@ -720,6 +716,10 @@ export declare const artifactsDiffOutputSchema: z.ZodObject<{
         }[];
         unchanged_count: number;
     } | undefined;
+    metrics?: {
+        elapsed_ms: number;
+        tool: string;
+    } | undefined;
     warnings?: string[] | undefined;
     errors?: string[] | undefined;
 }>;

package/dist/tools/artifacts-list.d.ts

@@ -169,16 +169,16 @@ export declare const ArtifactsListOutputSchema: z.ZodObject<{
             }, "strip", z.ZodTypeAny, {
                 count: number;
                 latest_created_at: string;
+                types: string[];
                 untracked_count: number;
                 tracked_count: number;
-                types: string[];
                 retention_buckets: string[];
             }, {
                 count: number;
                 latest_created_at: string;
+                types: string[];
                 untracked_count: number;
                 tracked_count: number;
-                types: string[];
                 retention_buckets: string[];
             }>>;
             by_retention_bucket: z.ZodRecord<z.ZodString, z.ZodNumber>;
@@ -205,9 +205,9 @@ export declare const ArtifactsListOutputSchema: z.ZodObject<{
             session_index: Record<string, {
                 count: number;
                 latest_created_at: string;
+                types: string[];
                 untracked_count: number;
                 tracked_count: number;
-                types: string[];
                 retention_buckets: string[];
             }>;
             by_retention_bucket: Record<string, number>;
@@ -234,9 +234,9 @@ export declare const ArtifactsListOutputSchema: z.ZodObject<{
             session_index: Record<string, {
                 count: number;
                 latest_created_at: string;
+                types: string[];
                 untracked_count: number;
                 tracked_count: number;
-                types: string[];
                 retention_buckets: string[];
             }>;
             by_retention_bucket: Record<string, number>;
@@ -266,9 +266,9 @@ export declare const ArtifactsListOutputSchema: z.ZodObject<{
             session_index: Record<string, {
                 count: number;
                 latest_created_at: string;
+                types: string[];
                 untracked_count: number;
                 tracked_count: number;
-                types: string[];
                 retention_buckets: string[];
             }>;
             by_retention_bucket: Record<string, number>;
@@ -325,9 +325,9 @@ export declare const ArtifactsListOutputSchema: z.ZodObject<{
             session_index: Record<string, {
                 count: number;
                 latest_created_at: string;
+                types: string[];
                 untracked_count: number;
                 tracked_count: number;
-                types: string[];
                 retention_buckets: string[];
             }>;
             by_retention_bucket: Record<string, number>;
@@ -375,10 +375,6 @@ export declare const ArtifactsListOutputSchema: z.ZodObject<{
     }>>;
 }, "strip", z.ZodTypeAny, {
     ok: boolean;
-    metrics?: {
-        elapsed_ms: number;
-        tool: string;
-    } | undefined;
     data?: {
         sample_id: string;
         summary: {
@@ -403,9 +399,9 @@ export declare const ArtifactsListOutputSchema: z.ZodObject<{
             session_index: Record<string, {
                 count: number;
                 latest_created_at: string;
+                types: string[];
                 untracked_count: number;
                 tracked_count: number;
-                types: string[];
                 retention_buckets: string[];
             }>;
             by_retention_bucket: Record<string, number>;
@@ -439,14 +435,14 @@ export declare const ArtifactsListOutputSchema: z.ZodObject<{
         latest_only: boolean;
         total_pages: number;
     } | undefined;
-    warnings?: string[] | undefined;
-    errors?: string[] | undefined;
-}, {
-    ok: boolean;
     metrics?: {
         elapsed_ms: number;
         tool: string;
     } | undefined;
+    warnings?: string[] | undefined;
+    errors?: string[] | undefined;
+}, {
+    ok: boolean;
     data?: {
         sample_id: string;
         summary: {
@@ -471,9 +467,9 @@ export declare const ArtifactsListOutputSchema: z.ZodObject<{
             session_index: Record<string, {
                 count: number;
                 latest_created_at: string;
+                types: string[];
                 untracked_count: number;
                 tracked_count: number;
-                types: string[];
                 retention_buckets: string[];
             }>;
             by_retention_bucket: Record<string, number>;
@@ -507,6 +503,10 @@ export declare const ArtifactsListOutputSchema: z.ZodObject<{
         latest_only: boolean;
         total_pages: number;
     } | undefined;
+    metrics?: {
+        elapsed_ms: number;
+        tool: string;
+    } | undefined;
     warnings?: string[] | undefined;
     errors?: string[] | undefined;
 }>;

package/dist/tools/attack-map.d.ts

@@ -172,10 +172,6 @@ export declare const AttackMapOutputSchema: z.ZodObject<{
     }>>;
 }, "strip", z.ZodTypeAny, {
     ok: boolean;
-    metrics?: {
-        elapsed_ms: number;
-        tool: string;
-    } | undefined;
     data?: {
         sample_id: string;
         inference: {
@@ -204,14 +200,14 @@ export declare const AttackMapOutputSchema: z.ZodObject<{
         }[];
         tactic_summary: Record<string, number>;
     } | undefined;
-    warnings?: string[] | undefined;
-    errors?: string[] | undefined;
-}, {
-    ok: boolean;
     metrics?: {
         elapsed_ms: number;
         tool: string;
     } | undefined;
+    warnings?: string[] | undefined;
+    errors?: string[] | undefined;
+}, {
+    ok: boolean;
     data?: {
         sample_id: string;
         inference: {
@@ -240,6 +236,10 @@ export declare const AttackMapOutputSchema: z.ZodObject<{
         }[];
         tactic_summary: Record<string, number>;
     } | undefined;
+    metrics?: {
+        elapsed_ms: number;
+        tool: string;
+    } | undefined;
     warnings?: string[] | undefined;
     errors?: string[] | undefined;
 }>;