From 11d3c7ad0c9dae4d3f6217d284917f0e9d712b6f Mon Sep 17 00:00:00 2001 From: Filipe C Menezes Date: Tue, 8 Apr 2025 11:32:26 +0100 Subject: [PATCH 1/2] chore: add LICENSE and fix version --- .github/workflows/code_health.yaml | 108 +++++++-------- LICENSE | 202 +++++++++++++++++++++++++++++ README.md | 12 +- dist/client.js | 4 +- dist/config.js | 6 +- dist/server.js | 2 +- package.json | 6 +- src/client.ts | 4 +- src/config.ts | 7 +- src/server.ts | 2 +- 10 files changed, 282 insertions(+), 71 deletions(-) create mode 100644 LICENSE diff --git a/.github/workflows/code_health.yaml b/.github/workflows/code_health.yaml index 4e36b0a9..8a385681 100644 --- a/.github/workflows/code_health.yaml +++ b/.github/workflows/code_health.yaml @@ -1,58 +1,58 @@ --- name: Code Health on: - push: - branches: - - main - pull_request: + push: + branches: + - main + pull_request: jobs: - build: - runs-on: ubuntu-latest - steps: - - uses: GitHubSecurityLab/actions-permissions/monitor@v1 - with: - config: ${{ vars.PERMISSIONS_CONFIG }} - - name: Checkout repository - uses: actions/checkout@v4 - - uses: actions/setup-node@v4 - with: - node-version-file: package.json - - name: install dependencies - run: | - npm ci - - name: build - run: | - npm run build - - name: Check for uncommitted files - run: | - export FILES= - FILES=$(git ls-files -o -m --directory --exclude-standard --no-empty-directory) - export LINES= - LINES=$(echo "$FILES" | awk 'NF' | wc -l) - if [ "$LINES" -ne 0 ]; then - echo "Detected files that need to be committed:" - echo "${FILES}" - echo "" - echo "Try running: npm run build" - exit 1 - fi - prettier: - name: Prettier Check - runs-on: ubuntu-latest - steps: - - uses: GitHubSecurityLab/actions-permissions/monitor@v1 - with: - config: ${{ vars.PERMISSIONS_CONFIG }} - - name: Checkout Repository - uses: actions/checkout@v2 - - name: Run Prettier - id: prettier-run - uses: rutajdash/prettier-cli-action@d42c4325a3b344f3bd4be482bc34de521998d557 - with: - config_path: ./.prettierrc.yml - - name: Prettier Output - if: ${{ failure() }} - shell: bash - run: | - echo "The following files are not formatted:" - echo "${{steps.prettier-run.outputs.prettier_output}}" \ No newline at end of file + build: + runs-on: ubuntu-latest + steps: + - uses: GitHubSecurityLab/actions-permissions/monitor@v1 + with: + config: ${{ vars.PERMISSIONS_CONFIG }} + - name: Checkout repository + uses: actions/checkout@v4 + - uses: actions/setup-node@v4 + with: + node-version-file: package.json + - name: install dependencies + run: | + npm ci + - name: build + run: | + npm run build + - name: Check for uncommitted files + run: | + export FILES= + FILES=$(git ls-files -o -m --directory --exclude-standard --no-empty-directory) + export LINES= + LINES=$(echo "$FILES" | awk 'NF' | wc -l) + if [ "$LINES" -ne 0 ]; then + echo "Detected files that need to be committed:" + echo "${FILES}" + echo "" + echo "Try running: npm run build" + exit 1 + fi + prettier: + name: Prettier Check + runs-on: ubuntu-latest + steps: + - uses: GitHubSecurityLab/actions-permissions/monitor@v1 + with: + config: ${{ vars.PERMISSIONS_CONFIG }} + - name: Checkout Repository + uses: actions/checkout@v2 + - name: Run Prettier + id: prettier-run + uses: rutajdash/prettier-cli-action@d42c4325a3b344f3bd4be482bc34de521998d557 + with: + config_path: ./.prettierrc.yml + - name: Prettier Output + if: ${{ failure() }} + shell: bash + run: | + echo "The following files are not formatted:" + echo "${{steps.prettier-run.outputs.prettier_output}}" diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..7a4a3ea2 --- /dev/null +++ b/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 [yyyy] [name of copyright owner] + + 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. \ No newline at end of file diff --git a/README.md b/README.md index 486e522b..8825ce68 100644 --- a/README.md +++ b/README.md @@ -101,13 +101,13 @@ It should look like this ```json { - "servers": { - "demo-atlas-server": { - "type": "stdio", - "command": "/Users//workplace/atlas-mcp-server/dist/index.js", - "args": [] - } + "servers": { + "demo-atlas-server": { + "type": "stdio", + "command": "/Users//workplace/atlas-mcp-server/dist/index.js", + "args": [] } + } } ``` diff --git a/dist/client.js b/dist/client.js index 6b589aa6..dd6bc8df 100644 --- a/dist/client.js +++ b/dist/client.js @@ -24,7 +24,7 @@ export class ApiClient { headers: { "Content-Type": "application/json", Accept: "application/vnd.atlas.2025-04-07+json", - "User-Agent": `AtlasMCP/${config.version} (${process.platform}; ${process.arch}; ${process.env.HOSTNAME || "unknown"})`, + "User-Agent": config.userAgent, ...authHeaders, }, }; @@ -153,7 +153,7 @@ export class ApiClient { headers: { "Content-Type": "application/x-www-form-urlencoded", Accept: "application/json", - "User-Agent": `AtlasMCP/${process.env.VERSION} (${process.platform}; ${process.arch}; ${process.env.HOSTNAME || "unknown"})`, + "User-Agent": config.userAgent, }, body: new URLSearchParams({ client_id: config.clientID, diff --git a/dist/config.js b/dist/config.js index b3dcc181..40fedc8b 100644 --- a/dist/config.js +++ b/dist/config.js @@ -1,9 +1,13 @@ import path from "path"; +import fs from "fs"; +const packageMetadata = fs.readFileSync(path.resolve("./package.json"), "utf8"); +const packageJson = JSON.parse(packageMetadata); export const config = { - version: process.env.VERSION || "1.0.0", + version: packageJson.version, apiBaseURL: process.env.API_BASE_URL || "https://cloud.mongodb.com/", clientID: process.env.CLIENT_ID || "0oabtxactgS3gHIR0297", stateFile: process.env.STATE_FILE || path.resolve("./state.json"), projectID: process.env.PROJECT_ID, + userAgent: `AtlasMCP/${packageJson.version} (${process.platform}; ${process.arch}; ${process.env.HOSTNAME || "unknown"})`, }; export default config; diff --git a/dist/server.js b/dist/server.js index 8963ca2a..b8c585ca 100644 --- a/dist/server.js +++ b/dist/server.js @@ -215,7 +215,7 @@ export class Server { mcpServer() { const server = new McpServer({ name: "MongoDB Atlas", - version: process.env.VERSION || "1.0.0", + version: config.version, }); server.tool("auth", "Authenticate to Atlas", async ({}) => this.authTool()); let projectIdFilter = z.string().describe("Optional Atlas project ID to filter clusters"); diff --git a/package.json b/package.json index a92d15c6..980362ad 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { - "name": "atlas-mcp-server", - "version": "1.0.0", + "name": "mongodb-mcp-server", + "version": "0.0.0", "private": true, "main": "dist/index.js", "type": "module", @@ -14,7 +14,7 @@ "prettier": "prettier", "reformat": "npm run prettier -- --write ." }, - "license": "MIT", + "license": "Apache-2.0", "devDependencies": { "@modelcontextprotocol/sdk": "^1.8.0", "@types/node": "^22.14.0", diff --git a/src/client.ts b/src/client.ts index 57271f4a..ab2b0006 100644 --- a/src/client.ts +++ b/src/client.ts @@ -87,7 +87,7 @@ export class ApiClient { headers: { "Content-Type": "application/json", Accept: "application/vnd.atlas.2025-04-07+json", - "User-Agent": `AtlasMCP/${config.version} (${process.platform}; ${process.arch}; ${process.env.HOSTNAME || "unknown"})`, + "User-Agent": config.userAgent, ...authHeaders, }, }; @@ -235,7 +235,7 @@ export class ApiClient { headers: { "Content-Type": "application/x-www-form-urlencoded", Accept: "application/json", - "User-Agent": `AtlasMCP/${process.env.VERSION} (${process.platform}; ${process.arch}; ${process.env.HOSTNAME || "unknown"})`, + "User-Agent": config.userAgent, }, body: new URLSearchParams({ client_id: config.clientID, diff --git a/src/config.ts b/src/config.ts index 5eb58b13..29b5eeb3 100644 --- a/src/config.ts +++ b/src/config.ts @@ -1,11 +1,16 @@ import path from "path"; +import fs from "fs"; + +const packageMetadata = fs.readFileSync(path.resolve("./package.json"), "utf8"); +const packageJson = JSON.parse(packageMetadata); export const config = { - version: process.env.VERSION || "1.0.0", + version: packageJson.version, apiBaseURL: process.env.API_BASE_URL || "https://cloud.mongodb.com/", clientID: process.env.CLIENT_ID || "0oabtxactgS3gHIR0297", stateFile: process.env.STATE_FILE || path.resolve("./state.json"), projectID: process.env.PROJECT_ID, + userAgent: `AtlasMCP/${packageJson.version} (${process.platform}; ${process.arch}; ${process.env.HOSTNAME || "unknown"})`, }; export default config; diff --git a/src/server.ts b/src/server.ts index d7dcd65a..772a962e 100644 --- a/src/server.ts +++ b/src/server.ts @@ -234,7 +234,7 @@ export class Server { private mcpServer(): McpServer { const server = new McpServer({ name: "MongoDB Atlas", - version: process.env.VERSION || "1.0.0", + version: config.version, }); server.tool("auth", "Authenticate to Atlas", async ({}) => this.authTool()); From be77a12a18141ede76249399494adf664cd50595 Mon Sep 17 00:00:00 2001 From: Filipe C Menezes Date: Tue, 8 Apr 2025 11:46:12 +0100 Subject: [PATCH 2/2] fix --- dist/server.js | 4 ++-- src/server.ts | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/dist/server.js b/dist/server.js index b8c585ca..5e9f4a63 100644 --- a/dist/server.js +++ b/dist/server.js @@ -212,7 +212,7 @@ export class Server { }; } } - mcpServer() { + createMcpServer() { const server = new McpServer({ name: "MongoDB Atlas", version: config.version, @@ -230,7 +230,7 @@ export class Server { } async connect(transport) { await this.init(); - const server = this.mcpServer(); + const server = this.createMcpServer(); await server.connect(transport); } } diff --git a/src/server.ts b/src/server.ts index 772a962e..04f16da3 100644 --- a/src/server.ts +++ b/src/server.ts @@ -231,7 +231,7 @@ export class Server { } } - private mcpServer(): McpServer { + private createMcpServer(): McpServer { const server = new McpServer({ name: "MongoDB Atlas", version: config.version, @@ -259,7 +259,7 @@ export class Server { async connect(transport: any) { await this.init(); - const server = this.mcpServer(); + const server = this.createMcpServer(); await server.connect(transport); } }