For AI agents: the complete documentation index is available at https://scriptedalchemy.github.io/agent-bundle/llms.txt, the full documentation bundle is available at https://scriptedalchemy.github.io/agent-bundle/llms-full.txt, and this page is available as Markdown at https://scriptedalchemy.github.io/agent-bundle/api/interfaces/api.RunMcpOptions.md.
  • English
  • Interface: RunMcpOptions

    Extends

    Properties

    artifact?

    readonly optional artifact?: string

    Inherited from

    ArtifactOperationOptions.artifact


    configPath?

    readonly optional configPath?: string

    Inherited from

    ArtifactOperationOptions.configPath


    envFiles?

    readonly optional envFiles?: readonly string[]

    Explicit .env files replacing the conventional project-root set. Loaded in order, later files winning on collision; relative paths resolve from the working directory.


    loadEnvFiles?

    readonly optional loadEnvFiles?: boolean

    Set false to launch the server without any .env layer.


    logger?

    readonly optional logger?: StructuredLogger

    Inherited from

    ArtifactOperationOptions.logger


    mode?

    readonly optional mode?: string

    Inherited from

    ArtifactOperationOptions.mode


    pluginRoot?

    readonly optional pluginRoot?: string

    Root the env-declared plugin-root anchors (for example AGENT_BUNDLE_PLUGIN_ROOT) expand to. Defaults to the project root so durable server state survives artifact rebuilds; point it at the artifact target root for a byte-faithful rehearsal of a copied-artifact launch.


    registry?

    readonly optional registry?: TargetRegistry

    Advanced adapter registry used for every source, artifact, and runtime operation.

    Inherited from

    ArtifactOperationOptions.registry


    root

    readonly root: string

    Inherited from

    ArtifactOperationOptions.root


    server

    readonly server: string


    spawnProcess?

    readonly optional spawnProcess?: (command, args, options) => ChildProcess

    Injectable only to make foreground process behavior deterministic in tests.

    Parameters

    command

    string

    args

    readonly string[]

    options
    cwd

    string

    env

    Readonly<Record<string, string>>

    stdio

    "inherit"

    Returns

    ChildProcess


    target

    readonly target: string


    targets?

    readonly optional targets?: readonly string[]

    Inherited from

    ArtifactOperationOptions.targets