-
v1.2.0-alpha — Mode-aware interactive installer
Pre-releasereleased this
2026-02-15 18:48:30 +00:00 | 179 commits to main since this releaseHighlights
The first-run installer now asks which deployment mode you want and guides
.envcreation accordingly. Previously it only supported stdio — now it handles all three modes.What's new
Mode-aware installer (OP#459)
Running
npx open-project-sidecar-mcpwith no.envnow walks you through:- Deployment mode selection — Local (stdio), Remote (HTTP), or Docker sidecar
- Mode-specific credential prompts:
- stdio: OpenProject URL + API key
- HTTP server: above + port selection, auto-generated
MCP_API_KEY - HTTP client: remote server URL + API key (no
.envcreated) - Docker: above + container name
- Connectivity test — verifies your OpenProject instance is reachable
.envcreation — writes credentials to a local file (or appends Docker keys to existing.env)- Client registration — writes config to
~/.claude.json(or preferred MCP client)
Shared helpers
Extracted reusable functions used by both
promptEnvSetup()(first-run) andrunSetupWizard()(--setup):buildEnvContent(mode, credentials)— generates.envcontent for any modebuildClientConfig(mode, credentials)— generates MCP client config objectpromptDeploymentMode()/promptCredentials()— interactive promptstestHealth()/testApiDirect()— moved to module scope for shared use
Updated
--helpoutput- Removed stale
envblock from Claude Code example - Added
--setupand--setup-jsonto options list - Lists all supported environment variables including HTTP transport vars
README rewrite
- Quick Start now leads with the installer (
npx open-project-sidecar-mcp) - Each deployment mode section references the installer
- New Manual configuration subsection with heredoc examples for CI/scripted use
Tests
- 11 new unit tests for
buildEnvContent()andbuildClientConfig()across all modes - 114 tests total, all passing
Install / upgrade
npx open-project-sidecar-mcp@1.2.0-alphaFull changelog
refactor(setup): extract testHealth and testApiDirect to module scope (OP#460)feat(setup): add mode-specific .env templates and buildEnvContent (OP#461)feat(setup): add promptDeploymentMode, promptCredentials, buildClientConfig (OP#462)feat(setup): refactor promptEnvSetup with mode selection and Docker .env merge (OP#463)refactor(setup): simplify runSetupWizard to use shared helpers (OP#464)fix(help): update --help output with installer info and remove env block (OP#465)docs: update README with installer-first Quick Start and manual config section (OP#466)test: add unit tests for buildEnvContent and buildClientConfig (OP#467)
Downloads
-
Source code (ZIP)
0 downloads
-
Source code (TAR.GZ)
0 downloads