chore(build): build a universal ESM and CommonJS package (#371)

Co-authored-by: Himanshu Singh <[email protected]>

Author: gagik

.github/workflows/check.yml

@@ -55,4 +55,4 @@ jobs:
           rm -rf node_modules
           npm pkg set scripts.prepare="exit 0"
           npm install --omit=dev
-      - run: npx -y @modelcontextprotocol/inspector --cli --method tools/list -- node dist/index.js
+      - run: npx -y @modelcontextprotocol/inspector --cli --method tools/list -- node dist/esm/index.js

.github/workflows/prepare_release.yaml

@@ -32,6 +32,7 @@ jobs:
         id: bump-version
         run: |
           echo "NEW_VERSION=$(npm version ${{ inputs.version }} --no-git-tag-version)" >> $GITHUB_OUTPUT
+          npm run build:update-package-version
       - name: Create release PR
         uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # 7.0.8
         id: create-pr

.smithery/Dockerfile

@@ -27,4 +27,4 @@ RUN npm ci --production --ignore-scripts
 # Expose no ports (stdio only)
 
 # Default command
-CMD ["node", "dist/index.js"]
+CMD ["node", "dist/esm/index.js"]

.smithery/smithery.yaml

@@ -40,7 +40,7 @@ startCommand:
     # A function that produces the CLI command to start the MCP on stdio.
     |-
     (config) => {
-      const args = ['dist/index.js'];
+      const args = ['dist/esm/index.js'];
       if (config) {
         if (config.atlasClientId) {
           args.push('--apiClientId');

CONTRIBUTING.md

@@ -33,7 +33,7 @@ This project implements a Model Context Protocol (MCP) server for MongoDB and Mo
    {
      "mcpServers": {
        "MongoDB": {
-         "command": "/path/to/mongodb-mcp-server/dist/index.js"
+         "command": "/path/to/mongodb-mcp-server/dist/esm/index.js"
        }
      }
    }
@@ -104,7 +104,7 @@ npm run inspect
 This is equivalent to:
 
 ```shell
-npx @modelcontextprotocol/inspector -- node dist/index.js
+npx @modelcontextprotocol/inspector -- node dist/esm/index.js
 ```
 
 ## Pull Request Guidelines

package-lock.json

@@ -2,28 +2,47 @@
   "name": "mongodb-mcp-server",
   "description": "MongoDB Model Context Protocol Server",
   "version": "0.2.0",
-  "main": "dist/index.js",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/esm/lib.d.ts",
+        "default": "./dist/esm/lib.js"
+      },
+      "require": {
+        "types": "./dist/cjs/lib.d.ts",
+        "default": "./dist/cjs/lib.js"
+      }
+    }
+  },
+  "main": "./dist/cjs/lib.js",
+  "types": "./dist/cjs/lib.d.ts",
   "author": "MongoDB <[email protected]>",
   "homepage": "https://github.com/mongodb-js/mongodb-mcp-server",
   "repository": {
     "url": "https://github.com/mongodb-js/mongodb-mcp-server.git"
   },
   "bin": {
-    "mongodb-mcp-server": "dist/index.js"
+    "mongodb-mcp-server": "dist/esm/index.js"
   },
   "publishConfig": {
     "access": "public"
   },
-  "type": "module",
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "start": "node dist/index.js --transport http --loggers stderr mcp",
     "start:stdio": "node dist/index.js --transport stdio --loggers stderr mcp",
     "prepare": "npm run build",
     "build:clean": "rm -rf dist",
-    "build:compile": "tsc --project tsconfig.build.json",
-    "build:chmod": "chmod +x dist/index.js",
-    "build": "npm run build:clean && npm run build:compile && npm run build:chmod",
-    "inspect": "npm run build && mcp-inspector -- dist/index.js",
+    "build:update-package-version": "tsx scripts/updatePackageVersion.ts",
+    "build:esm": "tsc --project tsconfig.esm.json",
+    "build:cjs": "tsc --project tsconfig.cjs.json",
+    "build:universal-package": "tsx scripts/createUniversalPackage.ts",
+    "build:chmod": "chmod +x dist/esm/index.js",
+    "build": "npm run build:clean && npm run build:esm && npm run build:cjs && npm run build:universal-package && npm run build:chmod",
+    "inspect": "npm run build && mcp-inspector -- dist/esm/index.js",
     "prettier": "prettier",
     "check": "npm run build && npm run check:types && npm run check:lint && npm run check:format",
     "check:lint": "eslint .",

package.json

@@ -0,0 +1,25 @@
+#!/usr/bin/env tsx
+
+import { writeFileSync, mkdirSync } from "fs";
+import { resolve } from "path";
+
+const distDir = resolve("dist");
+
+/**
+ * Node uses the package.json to know whether files with a .js extensions
+ * should be interpreted as CommonJS or ESM.
+ */
+// ESM package.json
+const esmPath = resolve(distDir, "esm", "package.json");
+mkdirSync(resolve(distDir, "esm"), { recursive: true });
+writeFileSync(esmPath, JSON.stringify({ type: "module" }));
+
+// CJS package.json
+const cjsPath = resolve(distDir, "cjs", "package.json");
+mkdirSync(resolve(distDir, "cjs"), { recursive: true });
+writeFileSync(cjsPath, JSON.stringify({ type: "commonjs" }));
+
+// Create a dist/index.js file that imports the ESM index.js file
+// To minimize breaking changes from pre-universal package time.
+const indexPath = resolve(distDir, "index.js");
+writeFileSync(indexPath, `import "./esm/index.js";`);

scripts/createUniversalPackage.ts

@@ -0,0 +1,22 @@
+#!/usr/bin/env node
+
+import { readFileSync, writeFileSync } from "fs";
+import { join } from "path";
+
+// Read package.json
+const packageJsonPath = join(import.meta.dirname, "..", "package.json");
+const packageJson = JSON.parse(readFileSync(packageJsonPath, "utf-8")) as {
+    version: string;
+};
+
+// Define the packageInfo.ts content
+const packageInfoContent = `// This file was generated by scripts/updatePackageVersion.ts - Do not edit it manually.
+export const packageInfo = {
+    version: "${packageJson.version}",
+    mcpServerName: "MongoDB MCP Server",
+};
+`;
+
+// Write to packageInfo.ts
+const packageInfoPath = join(import.meta.dirname, "..", "src", "common", "packageInfo.ts");
+writeFileSync(packageInfoPath, packageInfoContent);

scripts/updatePackageVersion.ts

@@ -1,6 +1,5 @@
-import packageJson from "../../package.json" with { type: "json" };
-
+// This file was generated by scripts/updatePackageVersion.ts - Do not edit it manually.
 export const packageInfo = {
-    version: packageJson.version,
+    version: "0.2.0",
     mcpServerName: "MongoDB MCP Server",
 };