bomly-mcp 0.21.1

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 bomly.dev
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,7 @@
+Bomly CLI
+Copyright 2026 bomly.dev
+
+This product includes software developed at bomly.dev (https://bomly.dev).
+
+This product includes third-party software. See the licenses/ directory
+in release archives for the full text of each dependency's license.

package/README.md

@@ -0,0 +1,65 @@
+<!-- mcp-name: io.github.bomly-dev/bomly-cli -->
+
+# bomly-mcp
+
+Give your coding agent the dependency graph it is about to change.
+
+`bomly-mcp` starts the [Bomly](https://github.com/bomly-dev/bomly-cli) MCP server over stdio, so an MCP-aware agent can generate, diff, explain, and audit dependencies itself instead of asking you to paste scan output into chat.
+
+Free and open source, no account, no login.
+
+## Use it
+
+```bash
+npx -y bomly-mcp
+```
+
+Claude Code:
+
+```bash
+claude mcp add --transport stdio bomly -- npx -y bomly-mcp
+```
+
+Cursor or VS Code, in `.cursor/mcp.json` or `.vscode/mcp.json`:
+
+```json
+{
+  "mcpServers": {
+    "bomly": {
+      "type": "stdio",
+      "command": "npx",
+      "args": ["-y", "bomly-mcp"]
+    }
+  }
+}
+```
+
+If you already have the `bomly` CLI on `PATH`, you do not need this package — point your client at `bomly mcp serve` instead.
+
+## Tools
+
+| Tool | Use it for |
+| --- | --- |
+| `bomly_scan` | Scan a path, Git URL, container image, or SBOM and return a compact dependency summary. |
+| `bomly_explain` | Show why one package is present, with full advisory details when enriched. |
+| `bomly_diff` | Compare dependencies between Git refs, container images, or SBOM files. |
+| `bomly_plugins` | List built-in and installed plugins with their enabled state. |
+
+Full setup, arguments, and troubleshooting: [docs/MCP.md](https://github.com/bomly-dev/bomly-cli/blob/main/docs/MCP.md).
+
+## How it installs
+
+The postinstall step downloads the Bomly release archive for your platform from GitHub Releases, checks it against that release's `SHA256SUMS`, and unpacks the binary into the package. A checksum mismatch fails the install; there is no unverified fallback.
+
+Environment overrides:
+
+- `BOMLY_MCP_VERSION` — download a different CLI version.
+- `BOMLY_MCP_SKIP_DOWNLOAD=1` — skip the download (for lint or CI installs that never run the server).
+
+Supported: macOS, Linux, and Windows on x64 and arm64.
+
+## Network behavior
+
+The server runs as you, on your machine, and reads the project files the Bomly process can read. Vulnerability, license, lifecycle, and scorecard lookups are opt-in per call via `enrich`. Some detectors invoke package-manager commands, and those tools can contact package registries as part of normal dependency resolution. See [Detectors](https://github.com/bomly-dev/bomly-cli/blob/main/docs/DETECTORS.md#network-behavior).
+
+Apache-2.0.

package/bin/bomly-mcp.js

@@ -0,0 +1,62 @@
+#!/usr/bin/env node
+// Starts the Bomly MCP server over stdio.
+//
+// This process must stay transparent: stdout carries the JSON-RPC stream and
+// nothing else. Diagnostics go to stderr, which is where `bomly mcp serve`
+// already writes its startup banner.
+
+"use strict";
+
+const { spawn } = require("node:child_process");
+const fs = require("node:fs");
+const path = require("node:path");
+
+const binary = process.platform === "win32" ? "bomly.exe" : "bomly";
+const vendored = path.join(__dirname, "..", "vendor", binary);
+
+if (!fs.existsSync(vendored)) {
+  console.error(
+    "bomly-mcp: the Bomly binary is missing. Reinstall the package so its postinstall step can run:\n" +
+      "  npm install bomly-mcp\n" +
+      "Or install the CLI directly and run `bomly mcp serve` instead:\n" +
+      "  https://github.com/bomly-dev/bomly-cli/blob/main/docs/INSTALLATION.md",
+  );
+  process.exit(1);
+}
+
+const child = spawn(vendored, ["mcp", "serve", ...process.argv.slice(2)], {
+  stdio: "inherit",
+});
+
+child.on("error", (error) => {
+  console.error(`bomly-mcp: could not start ${vendored}: ${error.message}`);
+  process.exit(1);
+});
+
+// Forward the signals an MCP client uses to stop a stdio server, so the child
+// shuts down with us rather than being orphaned.
+const forwarders = new Map();
+for (const signal of ["SIGINT", "SIGTERM", "SIGHUP"]) {
+  const forward = () => child.kill(signal);
+  forwarders.set(signal, forward);
+  process.on(signal, forward);
+}
+
+child.on("exit", (code, signal) => {
+  if (signal) {
+    // Adding a listener above replaced Node's default terminate-on-signal
+    // behavior. Re-raising while it is still attached only re-enters our own
+    // handler; the event loop then drains and we exit 0 — telling whatever
+    // supervises us that the server shut down cleanly when it was actually
+    // killed. Removing the listener first lets the signal reach the default
+    // handler, so we die of the same cause the child did. process.exit is the
+    // backstop for platforms where re-raising does not terminate us.
+    const forward = forwarders.get(signal);
+    if (forward) {
+      process.removeListener(signal, forward);
+    }
+    process.kill(process.pid, signal);
+    process.exit(1);
+  }
+  process.exit(code === null ? 1 : code);
+});

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "bomly-mcp",
+  "version": "0.21.1",
+  "description": "Run the Bomly MCP server with npx. Downloads the matching Bomly CLI release binary and starts `bomly mcp serve`.",
+  "mcpName": "io.github.bomly-dev/bomly-cli",
+  "license": "Apache-2.0",
+  "author": "Ahmed ElMallah <ahmed@bomly.dev>",
+  "homepage": "https://bomly.dev/cli",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/bomly-dev/bomly-cli.git",
+    "directory": "npm"
+  },
+  "bugs": {
+    "url": "https://github.com/bomly-dev/bomly-cli/issues"
+  },
+  "keywords": [
+    "mcp",
+    "model-context-protocol",
+    "sbom",
+    "dependencies",
+    "cyclonedx",
+    "spdx",
+    "bomly"
+  ],
+  "bin": {
+    "bomly-mcp": "bin/bomly-mcp.js"
+  },
+  "files": [
+    "bin/",
+    "scripts/",
+    "README.md",
+    "LICENSE",
+    "NOTICE"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "os": [
+    "darwin",
+    "linux",
+    "win32"
+  ],
+  "cpu": [
+    "x64",
+    "arm64"
+  ],
+  "scripts": {
+    "prepack": "node scripts/prepack.js",
+    "postinstall": "node scripts/postinstall.js",
+    "test": "node --test \"test/*.test.js\""
+  }
+}

package/scripts/postinstall.js

@@ -0,0 +1,184 @@
+#!/usr/bin/env node
+// Downloads the Bomly CLI release archive that matches this package version,
+// verifies it against the release's SHA256SUMS, and unpacks the `bomly`
+// binary into vendor/. bin/bomly-mcp.js then execs that binary.
+//
+// The download is verified or it fails. There is no unverified fallback.
+
+"use strict";
+
+const { createHash } = require("node:crypto");
+const { execFileSync } = require("node:child_process");
+const fs = require("node:fs");
+const os = require("node:os");
+const path = require("node:path");
+
+const pkg = require("../package.json");
+
+const ROOT = path.join(__dirname, "..");
+const VENDOR_DIR = path.join(ROOT, "vendor");
+const RELEASE_BASE = "https://github.com/bomly-dev/bomly-cli/releases/download";
+
+// Same names GoReleaser writes: bomly_<version>_<goos>_<goarch>.<tar.gz|zip>.
+const GOOS = { darwin: "darwin", linux: "linux", win32: "windows" };
+const GOARCH = { x64: "amd64", arm64: "arm64" };
+
+function fail(message) {
+  console.error(`bomly-mcp: ${message}`);
+  process.exit(1);
+}
+
+// Throws rather than exiting so it stays testable; main() turns the throw
+// into the user-facing message.
+function resolveTarget(platform, arch) {
+  const goos = GOOS[platform];
+  const goarch = GOARCH[arch];
+  if (!goos || !goarch) {
+    throw new Error(
+      `no Bomly release build for ${platform}/${arch}. ` +
+        "Install the CLI another way (https://github.com/bomly-dev/bomly-cli/blob/main/docs/INSTALLATION.md) " +
+        "and point your MCP client at `bomly mcp serve`.",
+    );
+  }
+  const ext = goos === "windows" ? "zip" : "tar.gz";
+  return { goos, goarch, ext, binary: goos === "windows" ? "bomly.exe" : "bomly" };
+}
+
+// Same names GoReleaser writes.
+function archiveNameFor(version, goos, goarch, ext) {
+  return `bomly_${version}_${goos}_${goarch}.${ext}`;
+}
+
+async function download(url) {
+  const response = await fetch(url, { redirect: "follow" });
+  if (!response.ok) {
+    fail(`GET ${url} returned HTTP ${response.status}`);
+  }
+  return Buffer.from(await response.arrayBuffer());
+}
+
+function sha256(buffer) {
+  return createHash("sha256").update(buffer).digest("hex");
+}
+
+// SHA256SUMS is `<hex>  <filename>` per line, as produced by GoReleaser.
+function expectedSum(sums, filename) {
+  for (const line of sums.split("\n")) {
+    const [hex, name] = line.trim().split(/\s+/);
+    if (name === filename) {
+      return hex;
+    }
+  }
+  return null;
+}
+
+// Written to disk and invoked with -File so the paths arrive as real argv
+// entries. Interpolating them into a -Command string breaks on any path
+// holding an apostrophe (C:\Users\O'Brien\...) and would let a path influence
+// the command itself.
+const EXPAND_PS1 = `param(
+  [Parameter(Mandatory=$true)][string]$Archive,
+  [Parameter(Mandatory=$true)][string]$Destination
+)
+$ErrorActionPreference = 'Stop'
+Expand-Archive -LiteralPath $Archive -DestinationPath $Destination -Force
+`;
+
+function unpack(archivePath, destination, ext) {
+  if (ext === "zip") {
+    // PowerShell ships with every supported Windows version; `tar` does too on
+    // Windows 10 1803+, but Expand-Archive is the safer floor for zip.
+    const scriptPath = path.join(destination, "expand.ps1");
+    fs.writeFileSync(scriptPath, EXPAND_PS1);
+    execFileSync(
+      "powershell",
+      [
+        "-NoProfile",
+        "-NonInteractive",
+        "-ExecutionPolicy",
+        "Bypass",
+        "-File",
+        scriptPath,
+        "-Archive",
+        archivePath,
+        "-Destination",
+        destination,
+      ],
+      { stdio: "inherit" },
+    );
+    return;
+  }
+  execFileSync("tar", ["-xzf", archivePath, "-C", destination], { stdio: "inherit" });
+}
+
+// The release archive carries LICENSE, NOTICE, and a licenses/ tree of
+// third-party license texts. Vendoring the binary without them would
+// redistribute Bomly and its bundled components with the notices stripped.
+function copyNotices(staging, destination) {
+  for (const entry of ["LICENSE", "NOTICE", "licenses"]) {
+    const from = path.join(staging, entry);
+    if (fs.existsSync(from)) {
+      fs.cpSync(from, path.join(destination, entry), { recursive: true });
+    }
+  }
+}
+
+async function main() {
+  if (process.env.BOMLY_MCP_SKIP_DOWNLOAD === "1") {
+    console.error("bomly-mcp: BOMLY_MCP_SKIP_DOWNLOAD=1, skipping binary download.");
+    return;
+  }
+
+  const version = process.env.BOMLY_MCP_VERSION || pkg.version;
+  const { ext, goos, goarch, binary } = resolveTarget(process.platform, process.arch);
+  const archiveName = archiveNameFor(version, goos, goarch, ext);
+  const tag = `v${version}`;
+
+  const sums = (await download(`${RELEASE_BASE}/${tag}/SHA256SUMS`)).toString("utf8");
+  const expected = expectedSum(sums, archiveName);
+  if (!expected) {
+    fail(`${archiveName} is not listed in the SHA256SUMS for ${tag}`);
+  }
+
+  const archive = await download(`${RELEASE_BASE}/${tag}/${archiveName}`);
+  const actual = sha256(archive);
+  if (actual !== expected) {
+    fail(
+      `checksum mismatch for ${archiveName}\n` +
+        `  expected ${expected}\n` +
+        `  actual   ${actual}\n` +
+        "Refusing to install. Please report this at https://github.com/bomly-dev/bomly-cli/issues.",
+    );
+  }
+
+  const staging = fs.mkdtempSync(path.join(os.tmpdir(), "bomly-mcp-"));
+  try {
+    const archivePath = path.join(staging, archiveName);
+    fs.writeFileSync(archivePath, archive);
+    unpack(archivePath, staging, ext);
+
+    const extracted = path.join(staging, binary);
+    if (!fs.existsSync(extracted)) {
+      fail(`${archiveName} did not contain ${binary}`);
+    }
+
+    fs.mkdirSync(VENDOR_DIR, { recursive: true });
+    const installed = path.join(VENDOR_DIR, binary);
+    fs.copyFileSync(extracted, installed);
+    if (goos !== "windows") {
+      fs.chmodSync(installed, 0o755);
+    }
+    copyNotices(staging, VENDOR_DIR);
+    console.error(`bomly-mcp: installed bomly ${version} (${goos}/${goarch}), checksum verified.`);
+  } finally {
+    fs.rmSync(staging, { recursive: true, force: true });
+  }
+}
+
+if (require.main === module) {
+  main().catch((error) => fail(error && error.message ? error.message : String(error)));
+}
+
+// Exported for test/. Everything here is pure or filesystem-local; the
+// network path is exercised end to end by installing a packed tarball.
+module.exports = { resolveTarget, archiveNameFor, expectedSum, sha256, unpack, copyNotices };

package/scripts/prepack.js

@@ -0,0 +1,27 @@
+#!/usr/bin/env node
+// Copies the repository LICENSE and NOTICE into the package before it is
+// packed, so the published tarball carries them.
+//
+// They are copied rather than committed here because a second copy in git
+// drifts from the originals. `files` in package.json lists them, and
+// .gitignore ignores them inside npm/.
+
+"use strict";
+
+const fs = require("node:fs");
+const path = require("node:path");
+
+const PACKAGE_DIR = path.join(__dirname, "..");
+const REPO_ROOT = path.join(PACKAGE_DIR, "..");
+
+for (const name of ["LICENSE", "NOTICE"]) {
+  const from = path.join(REPO_ROOT, name);
+  if (!fs.existsSync(from)) {
+    console.error(
+      `bomly-mcp: ${name} is missing at the repository root. ` +
+        "The package must not be published without it.",
+    );
+    process.exit(1);
+  }
+  fs.copyFileSync(from, path.join(PACKAGE_DIR, name));
+}