mcpwn API
    Preparing search index...

    Interface PipelineOptions

    Transport-agnostic processing options. A transport (stdio, and later HTTP) owns framing + I/O; the pipeline owns the parse→correlate→rules→intercept→ log→forward-decision chain and nothing else.

    interface PipelineOptions {
        detectors?: Detector[];
        findings?: FindingsSink;
        guard?: GuardEngine;
        holdTimeoutMs?: number;
        intercept?: InterceptController;
        logger: Logger;
        ruleActionPlugins?: RuleActionRegistry;
        rules: Rule[];
        scope?: Scope;
        scopeAffectsLog?: boolean;
    }
    Index
    detectors?: Detector[]

    Passive detectors (§3.4, §3.9). Run read-only on every parseable message; they only record findings and NEVER affect what is forwarded.

    findings?: FindingsSink

    Where detectors record findings.

    guard?: GuardEngine

    Guard-mode firewall (§3.14, --mode guard). When set, in-scope messages are evaluated against the policy and may be SANITISED or BLOCKED before forwarding. Fail-open: a guard that throws forwards the original. Guard mode is exclusive of tamper rules (the CLI leaves rules empty in guard mode).

    holdTimeoutMs?: number

    Max time to hold a message for interactive review before auto-forwarding. 0 (the default, used by stdio) means unlimited. A bounded hold is only meaningful for request/response transports (HTTP, M3).

    When set, hold messages for interactive review (the Repeater loop).

    logger: Logger
    ruleActionPlugins?: RuleActionRegistry

    Custom tamper-action kinds registered via --rule-plugin (§3.11). Threaded into the rules engine so a rule may reference a plugin's kind.

    rules: Rule[]
    scope?: Scope

    Narrow which traffic is "in scope" (§3.6). Out-of-scope messages are always forwarded untouched (no rules, no hold) and suppressed from the stderr log. When unset, all traffic is in scope (transparent).

    scopeAffectsLog?: boolean

    When true, out-of-scope messages are also omitted from the --log JSONL (--scope-affects-log). By default they are still recorded.