MirthSync for VS Code

Mirth Connect and Open Integration Engine development in VS Code — channel sync, IntelliSense for Mirth scripting APIs, multi-server connection management, and a one-command local Mirth Docker stack for offline testing.

By Saga IT, LLC

Note: This is a community extension developed by Saga IT, LLC. It is not affiliated with or endorsed by NextGen Healthcare.

Features

• Channel & Template Sync - Pull/push individual channels, channel groups, code template libraries, or sync all at once

• Connection Management - Multi-server connection profiles with secure credential storage (VS Code Secrets API)

• IntelliSense - Autocomplete and hover documentation for Mirth JavaScript APIs

  

• Status Bar Controls - Quick toggles for ConfigMap inclusion, Force sync, and Deploy after push

• File Explorer Integration - Right-click on Channels/CodeTemplates folders to pull/push directly

• Tree Views - Browse channels and code templates hierarchically with context menu actions

• Local Mirth - One-command Docker Compose stack with Open Integration Engine + Postgres, for testing this workspace against a throwaway local Mirth

Quick Start

1. Install the extension from the VS Code marketplace (or from VSIX)
2. Open Command Palette (Ctrl+Shift+P / Cmd+Shift+P)
3. Run MirthSync: Add Connection and enter your Mirth server details
4. Set the connection as active and connect
5. Use tree views or commands to pull/push channels

Commands

Connection Management

MirthSync Operations

Tree View Context Menu Commands

Mirth CLI Operations

Local Mirth

Settings

Tree Views

The extension adds three tree views to the Explorer sidebar:

Mirth Connections

Manage your Mirth server connections. Right-click for options:

• Connect/Disconnect
• Test Connection
• Set as Active
• Edit/Remove

Mirth Channels

Browse channels organized by channel groups (visible when connected). Right-click to:

• Pull/Push individual channels
• Pull/Push entire channel groups

Code Templates

Browse code template libraries (visible when connected). Right-click to:

• Pull/Push individual templates
• Pull/Push entire libraries

File Explorer Integration

When connected, right-click on folders in the file explorer to sync:

• Channels/ - Pull or push channel configurations
• CodeTemplates/ - Pull or push code template libraries
• GlobalScripts/ - Pull or push global scripts
• ConfigurationMap.xml - Pull or push configuration map
• Resources.xml - Pull or push resources

Status Bar

The status bar shows:

• Connection status - Current active connection and state
• ConfigMap - Whether Configuration Map is included (click to toggle)
• Force - Whether force sync is enabled (click to toggle)
• Deploy - Whether deploy after push is enabled (click to toggle)

Local Mirth

For testing this workspace against a throwaway local Mirth without installing anything on the host beyond Docker, run MirthSync: Initialize Local Mirth. It scaffolds .mirthsync/local/ with a compose stack:

• mirth — Saga-packaged Open Integration Engine (sagait/engine, OIE with Saga plugins preinstalled), exposed on 127.0.0.1:8443 (or an auto-chosen fallback if 8443 is busy)
• postgres — Mirth's backing database, on a named volume
• tools — Alpine + JRE + mirthsync (and curl/git/jq) for running CLI operations inside the stack

Set mirthsync.localMirth.mirthImageTag to switch to a different sagait/engine tag, or edit compose.yml to point at openintegrationengine/engine for vanilla OIE.

Then run MirthSync: Start Local Mirth. The extension auto-creates a Local Mirth connection and routes its mirthsync calls into the tools container, so you don't need mirthsync on your host for this workflow. If 8443 is already in use on your machine, the extension will detect the conflict, suggest an alternate port, and remember the choice in .mirthsync/local/.env for next time.

To open the Mirth Administrator against the local server, install a launcher on your host and point it at the URL shown in Show Local Mirth Info:

• Ballista — community launcher used with Open Integration Engine. Requires a host JRE 8+.
• NextGen MCAL — legacy NextGen Mirth Connect Administrator Launcher. Bundles its own JRE.

Default credentials are admin / admin; the Administrator will prompt you to change the password on first login.

Requirements

• VS Code 1.85.0 or higher
• mirthsync CLI tool (for sync operations against non-local Mirth servers)
• Mirth Connect 4.5.2+ or Open Integration Engine (OIE)
• Docker (only required for the Local Mirth feature)

Compatibility

This extension works with:

• Mirth Connect - The commercial integration engine by NextGen Healthcare
• Open Integration Engine (OIE) - The open source community edition (formerly Mirth Connect Open Source)

Both use the same underlying API, so MirthSync works seamlessly with either.

Installing mirthsync

The preferred method is via npm:

npm install -g @saga-it/mirthsync

Alternatively, download from GitHub releases.

Telemetry

This extension sends a small amount of anonymous usage data to help us decide what to build next. The data shapes our roadmap; without it we are guessing at which commands matter and which can be retired.

What we collect

• Which commands you run (the command ID — e.g. mirthsync.pull — and how long it took to complete).
• High-level outcomes of MirthSync pull/push and git operations: success or failure, duration. Never the channel, template, or script names being operated on.
• Connection counts (bucketed: 1, 2-3, 4-10, 10+) and whether each connection points at localhost vs. a remote host. Never the URL.
• Local Mirth lifecycle events (init, start, stop, reset, status) and a boolean for whether Docker is available.
• Error codes from our internal error classification (numeric codes only, e.g. 1001, 4004, mapped to categories like Connection, API).
• Which non-default settings you have enabled — as booleans. For path / URL / image-tag settings, only the boolean "has the user overridden the default?" is sent, never the value.
• VS Code's automatically-attached identifiers: OS, OS version, VS Code version, extension version, anonymised machine ID, session ID, UI kind (desktop / web), remote name (none / WSL / SSH / dev-container).

What we will never collect

• Channel names or content (transformer scripts, filter scripts, connector configuration, deployment scripts).
• Code template names or content.
• Global script content.
• ConfigurationMap content.
• Server URLs, hostnames, or ports. We derive a boolean isLocalhost from the host; the URL itself never leaves your machine.
• Usernames (Mirth or OS).
• Passwords, tokens, keys, certificates.
• File paths of any kind. Workspace paths, mirthsync paths, custom keystore paths, none of these.
• Workspace folder names or git remote URLs.
• stdout / stderr from any subprocess (mirthsync, docker compose, oiecommand).
• Free-form text you type into any input box (connection names, commit messages, etc.).
• Anything from the workspace filesystem beyond the booleans listed above.

How to opt out

Two switches; either one is enough to stop all sending:

• VS Code-wide: set telemetry.telemetryLevel to off. This affects every extension, not just this one. Recommended if you don't want any extension reporting telemetry.
• Just this extension: set mirthsync.telemetry.enabled to false.

When telemetry is off, the extension logs a one-line confirmation to the MirthSync Telemetry output channel on activation so you can verify it took effect.

How to inspect what's being sent

Set mirthsync.telemetry.showOutput to true (or run MirthSync: Show Telemetry Output) and every event we send — including the full property bag — is logged to the MirthSync Telemetry output channel as it goes out. You can flip this on at any time to audit exactly what's being collected.

Where the data goes

Azure Application Insights, in a resource group owned by Saga IT, LLC. Retention: 90 days. The infrastructure is defined as code at infra/telemetry/ and the data-collection design lives at doc/PLAN-TELEMETRY.md.

Related Projects

• mirthsync - CLI tool for syncing Mirth configurations
• Open Integration Engine (OIE) - Open source integration engine

License

Copyright (c) 2024-2026 Saga IT, LLC. All Rights Reserved.

This is proprietary software. See LICENSE for details.