merge main into gagik/use-device-id

Author: nirinchev

.github/workflows/lint.yml renamed to .github/workflows/check.yml

@@ -1,10 +1,13 @@
 ---
-name: Lint
+name: Checks
 on:
   push:
     branches:
       - main
   pull_request:
+  pull_request_target:
+    branches:
+      - main
 
 permissions: {}
 
@@ -35,3 +38,21 @@ jobs:
       - name: Install dependencies
         run: npm ci
       - run: npm run generate
+
+  check-dep:
+    name: Check dependencies
+    runs-on: ubuntu-latest
+    steps:
+      - uses: GitHubSecurityLab/actions-permissions/monitor@v1
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: package.json
+          cache: "npm"
+      - name: Install dependencies, build and remove dev dependencies
+        run: |
+          npm ci
+          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 --connectionString "mongodb://localhost"

.github/workflows/code_health.yaml

@@ -62,26 +62,6 @@ jobs:
           name: atlas-test-results
           path: coverage/lcov.info
 
-  dep-check:
-    name: Check dependencies
-    if: github.event.pull_request.user.login != 'dependabot[bot]' && github.event.pull_request.head.repo.full_name == github.repository
-    runs-on: ubuntu-latest
-    steps:
-      - uses: GitHubSecurityLab/actions-permissions/monitor@v1
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version-file: package.json
-          cache: "npm"
-      - name: Install dependencies & build
-        run: npm ci
-      - name: Remove dev dependencies
-        run: |
-          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 --connectionString "mongodb://localhost"
-
   coverage:
     name: Report Coverage
     if: always() && github.event.pull_request.user.login != 'dependabot[bot]' && github.event.pull_request.head.repo.full_name == github.repository

.github/workflows/code_health_fork.yaml

@@ -42,8 +42,6 @@ jobs:
     permissions:
       pull-requests: write
       contents: write
-    needs:
-      - run-tests
     steps:
       - name: Enable auto-merge for Dependabot PRs
         run: gh pr merge --auto --squash "$PR_URL"

.vscode/extensions.json

@@ -0,0 +1,9 @@
+{
+  // See https://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations.
+  // Extension identifier format: ${publisher}.${name}. Example: vscode.csharp
+
+  // List of extensions which should be recommended for users of this workspace.
+  "recommendations": ["firsttris.vscode-jest-runner", "orta.vscode-jest"],
+  // List of extensions recommended by VS Code that should not be recommended for users of this workspace.
+  "unwantedRecommendations": []
+}

.vscode/settings.json

@@ -0,0 +1,11 @@
+{
+  "jestrunner.jestCommand": "npm test --",
+  "jestrunner.debugOptions": {
+    "runtimeExecutable": "node",
+    "runtimeArgs": [
+      "--experimental-vm-modules",
+      "node_modules/jest/bin/jest.js",
+      "--coverage"
+    ]
+  }
+}

README.md

@@ -29,7 +29,7 @@ node -v
 ```
 
 - A MongoDB connection string or Atlas API credentials, **_the Server will not start unless configured_**.
-  - **_Atlas API credentials_** are required to use the Atlas tools. You can create a service account in MongoDB Atlas and use its credentials for authentication. See [Atlas API Access](#atlas-api-access) for more details.
+  - **_Service Accounts Atlas API credentials_** are required to use the Atlas tools. You can create a service account in MongoDB Atlas and use its credentials for authentication. See [Atlas API Access](#atlas-api-access) for more details.
   - If you have a MongoDB connection string, you can use it directly to connect to your MongoDB instance.
 
 ## Setup
@@ -67,7 +67,7 @@ You can pass your connection string via args, make sure to use a valid username
 
 #### Option 2: Atlas API credentials args
 
-Use your Atlas API Service Account credentials. More details in the [Atlas API Access](#atlas-api-access) section.
+Use your Atlas API Service Accounts credentials. Must follow all the steps in [Atlas API Access](#atlas-api-access) section.
 
 ```json
 {
@@ -78,18 +78,33 @@ Use your Atlas API Service Account credentials. More details in the [Atlas API A
         "-y",
         "mongodb-mcp-server",
         "--apiClientId",
-        "your-atlas-client-id",
+        "your-atlas-service-accounts-client-id",
         "--apiClientSecret",
-        "your-atlas-client-secret"
+        "your-atlas-service-accounts-client-secret"
       ]
     }
   }
 }
 ```
 
-#### Other options
+### Option 3: Standalone Service using command arguments
 
-Alternatively you can use environment variables in the config file or set them and run the server via npx.
+Start Server using npx command:
+
+```shell
+ npx -y mongodb-mcp-server --apiClientId="your-atlas-service-accounts-client-id" --apiClientSecret="your-atlas-service-accounts-client-secret"
+```
+
+- For a complete list of arguments see [Configuration Options](#configuration-options)
+- To configure your Atlas Service Accounts credentials please refer to [Atlas API Access](#atlas-api-access)
+
+#### Option 4: Standalone Service using environment variables
+
+```shell
+ npx -y mongodb-mcp-server
+```
+
+You can use environment variables in the config file or set them and run the server via npx.
 
 - Connection String via environment variables in the MCP file [example](#connection-string-with-environment-variables)
 - Atlas API credentials via environment variables in the MCP file [example](#atlas-api-credentials-with-environment-variables)
@@ -229,7 +244,7 @@ To learn more about Service Accounts, check the [MongoDB Atlas documentation](ht
    - After creation, you'll be shown the Client ID and Client Secret
    - **Important:** Copy and save the Client Secret immediately as it won't be displayed again
 
-3. **Add Access List Entry (Optional but recommended):**
+3. **Add Access List Entry:**
 
    - Add your IP address to the API access list
 
@@ -243,9 +258,9 @@ To learn more about Service Accounts, check the [MongoDB Atlas documentation](ht
 Set environment variables with the prefix `MDB_MCP_` followed by the option name in uppercase with underscores:
 
 ```shell
-# Set Atlas API credentials
-export MDB_MCP_API_CLIENT_ID="your-atlas-client-id"
-export MDB_MCP_API_CLIENT_SECRET="your-atlas-client-secret"
+# Set Atlas API credentials (via Service Accounts)
+export MDB_MCP_API_CLIENT_ID="your-atlas-service-accounts-client-id"
+export MDB_MCP_API_CLIENT_SECRET="your-atlas-service-accounts-client-secret"
 
 # Set a custom MongoDB connection string
 export MDB_MCP_CONNECTION_STRING="mongodb+srv://username:[email protected]/myDatabase"
@@ -281,8 +296,8 @@ export MDB_MCP_LOG_PATH="/path/to/logs"
       "command": "npx",
       "args": ["-y", "mongodb-mcp-server"],
       "env": {
-        "MDB_MCP_API_CLIENT_ID": "your-atlas-client-id",
-        "MDB_MCP_API_CLIENT_SECRET": "your-atlas-client-secret"
+        "MDB_MCP_API_CLIENT_ID": "your-atlas-service-accounts-client-id",
+        "MDB_MCP_API_CLIENT_SECRET": "your-atlas-service-accounts-client-secret"
       }
     }
   }
@@ -294,7 +309,7 @@ export MDB_MCP_LOG_PATH="/path/to/logs"
 Pass configuration options as command-line arguments when starting the server:
 
 ```shell
-npx -y mongodb-mcp-server --apiClientId="your-atlas-client-id" --apiClientSecret="your-atlas-client-secret" --connectionString="mongodb+srv://username:[email protected]/myDatabase" --logPath=/path/to/logs
+npx -y mongodb-mcp-server --apiClientId="your-atlas-service-accounts-client-id" --apiClientSecret="your-atlas-service-accounts-client-secret" --connectionString="mongodb+srv://username:[email protected]/myDatabase" --logPath=/path/to/logs
 ```
 
 #### MCP configuration file examples
@@ -328,9 +343,9 @@ npx -y mongodb-mcp-server --apiClientId="your-atlas-client-id" --apiClientSecret
         "-y",
         "mongodb-mcp-server",
         "--apiClientId",
-        "your-atlas-client-id",
+        "your-atlas-service-accounts-client-id",
         "--apiClientSecret",
-        "your-atlas-client-secret"
+        "your-atlas-service-accounts-client-secret"
       ]
     }
   }

eslint.config.js

@@ -49,6 +49,7 @@ export default defineConfig([
         "global.d.ts",
         "eslint.config.js",
         "jest.config.cjs",
+        "src/types/*.d.ts",
     ]),
     eslintPluginPrettierRecommended,
 ]);