Repo checklist (#34)

* feat: opensource checklist

* ci: add license checks

* Check node version

* ci: try fixing

* ci: fix pipeline

* chore: include notice in distribution

Author: jedrazb

.buildkite/default-pipeline.yml

@@ -1,5 +1,8 @@
 ---
 # $yaml-language-server: $schema=https://raw.githubusercontent.com/buildkite/pipeline-schema/main/schema.json
 steps:
+  - label: "Check License"
+    command: "npm install && npm run license-checker && npm run license-header"
+
   - label: "Build"
     command: "npm install && npm run build"

NOTICE.txt

@@ -183,6 +183,10 @@ POST /_security/api_key
 }
 ```
 
+## License
+
+This project is licensed under the Apache License 2.0.
+
 ## Troubleshooting
 
 * Ensure your MCP configuration is correct.

README.md

@@ -1,5 +1,10 @@
 #!/usr/bin/env node
 
+/*
+ * Copyright Elasticsearch B.V. and contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
 import { z } from "zod";
 import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { Client, estypes, ClientOptions } from "@elastic/elasticsearch";
@@ -52,7 +57,7 @@ const ConfigSchema = z
       if (data.apiKey) {
         return true;
       }
-      
+
       // No auth is also valid (for local development)
       return true;
     },
@@ -360,7 +365,9 @@ export async function createElasticsearchMcpServer(
 
         const metadataFragment = {
           type: "text" as const,
-          text: `Found ${shardsInfo.length} shards${index ? ` for index ${index}` : ""}`,
+          text: `Found ${shardsInfo.length} shards${
+            index ? ` for index ${index}` : ""
+          }`,
         };
 
         return {

index.ts

@@ -20,22 +20,32 @@
     "mcp-server"
   ],
   "files": [
-    "dist"
+    "dist",
+    "NOTICE.txt",
+    "LICENSE",
+    "README.md"
   ],
   "scripts": {
     "build": "tsc && shx chmod +x dist/*.js",
     "prepare": "npm run build",
     "watch": "tsc --watch",
     "start": "node dist/index.js",
     "inspector": "npx @modelcontextprotocol/inspector node dist/index.js",
-    "test": "npm run build"
+    "test": "npm run build",
+    "license-checker": "license-checker --production --onlyAllow='MIT;Apache-2.0;Apache1.1;ISC;BSD-3-Clause;BSD-2-Clause;0BSD'",
+    "license-header": "./scripts/check-spdx",
+    "generate-notice": "node ./scripts/generate-notice.js"
   },
   "dependencies": {
     "@elastic/elasticsearch": "^8.17.1",
     "@modelcontextprotocol/sdk": "1.8.0"
   },
+  "engines": {
+    "node": ">=18"
+  },
   "devDependencies": {
     "@types/node": "22.13.15",
+    "license-checker": "^25.0.1",
     "shx": "0.4.0",
     "typescript": "5.8.2"
   },

package.json

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+
+# Copyright Elasticsearch B.V. and contributors
+# SPDX-License-Identifier: Apache-2.0
+
+the_exit=0
+
+check_file() {
+  if grep -q "Copyright Elasticsearch B.V. and contributors" "$1" && \
+     grep -q "SPDX-License-Identifier: Apache-2.0" "$1"; then
+    echo "Correct: $1"
+  else
+    echo "Incorrect: $1"
+    the_exit=1
+  fi
+}
+
+echo "SPDX license header check"
+for file in $(git ls-files | grep -E '\.(ts|js|mjs)$'); do
+  check_file "$file"
+done
+
+exit "$the_exit"

scripts/check-spdx

@@ -0,0 +1,100 @@
+#!/usr/bin/env node
+
+/*
+ * Copyright Elasticsearch B.V. and contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { exec } from "child_process";
+import fs from "fs/promises";
+import path from "path";
+import { fileURLToPath } from "url";
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+// Execute license-checker command
+const generateNotice = () => {
+  return new Promise((resolve, reject) => {
+    exec("npx license-checker --json --production", (error, stdout) => {
+      if (error) {
+        return reject(error);
+      }
+      resolve(JSON.parse(stdout));
+    });
+  });
+};
+
+async function createNoticeFile() {
+  // Custom header for notice file
+  let noticeContent = `Elasticsearch MCP Server
+Copyright 2025 Elasticsearch B.V.
+
+The Elasticsearch MCP Server contains the following third-party dependencies:
+
+`;
+
+  try {
+    const licenses = await generateNotice();
+
+    for (const [pkgNameVer, info] of Object.entries(licenses)) {
+      const pkgName =
+        pkgNameVer.split("@")[0] === ""
+          ? "@" + pkgNameVer.split("@")[1]
+          : pkgNameVer.split("@")[0];
+
+      // Extract version from the pkgNameVer string
+      let version;
+      if (pkgNameVer.split("@")[0] === "") {
+        // Handle scoped packages (@organization/[email protected])
+        const parts = pkgNameVer.split("@");
+        if (parts.length >= 3) {
+          version = parts[2];
+        }
+      } else {
+        // Handle regular packages ([email protected])
+        const parts = pkgNameVer.split("@");
+        if (parts.length >= 2) {
+          version = parts[1];
+        }
+      }
+
+      // Use extracted version if available, otherwise fall back to info.version
+      const displayVersion = version || info.version || "";
+
+      noticeContent += `\n-------------------------------------------------------------------\n`;
+      noticeContent += `Package: ${pkgName}\n`;
+      noticeContent += `Version: ${displayVersion}\n`;
+      noticeContent += `License: ${info.licenses || "Unknown"}\n`;
+
+      if (info.publisher) {
+        noticeContent += `Author: ${info.publisher}\n`;
+      }
+
+      noticeContent += `\n`;
+
+      // Include license text if available
+      if (info.licenseFile && typeof info.licenseFile === "string") {
+        try {
+          const licenseText = await fs.readFile(info.licenseFile, "utf-8");
+          noticeContent += `${licenseText.trim()}\n`;
+        } catch (err) {
+          noticeContent += `License text not available.\n`;
+        }
+      } else {
+        noticeContent += `License text not available.\n`;
+      }
+    }
+
+    // Write the NOTICE.txt file in the repo root
+    await fs.writeFile(
+      path.join(__dirname, "..", "NOTICE.txt"),
+      noticeContent,
+      "utf-8"
+    );
+    console.log("NOTICE.txt file has been generated successfully.");
+  } catch (error) {
+    console.error("Error generating NOTICE.txt:", error);
+  }
+}
+
+createNoticeFile();