mongodb-mcp-server 0.1.0 → 0.1.2

package/.dockerignore

@@ -0,0 +1,11 @@
+dist
+node_modules
+.vscode
+.github
+.git
+# Environment variables
+.env
+
+tests
+coverage
+scripts

package/.github/CODEOWNERS

@@ -1,3 +1 @@
 *          @mongodb-js/mcp-server-developers
-**/atlas   @blva @fmenezes
-**/mongodb @nirinchev @gagik

package/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -7,6 +7,14 @@ body:
   - type: markdown
     attributes:
       value: "Please fill out the following details to help us address the issue."
+  - type: textarea
+    id: version
+    attributes:
+      label: "Version"
+      description: "Please provide the version of the MCP Server where the bug occurred. (e.g., 0.1.0, main branch sha, etc.)"
+      placeholder: "e.g., 0.1.0"
+    validations:
+      required: true
   - type: checkboxes
     id: app
     attributes:

package/.github/workflows/check-pr-title.yml

@@ -0,0 +1,29 @@
+name: "Check PR Title"
+on:
+  pull_request:
+    types:
+      [
+        opened,
+        synchronize,
+        reopened,
+        ready_for_review,
+        labeled,
+        unlabeled,
+        converted_to_draft,
+        edited,
+      ]
+
+permissions:
+  pull-requests: read # to read PR title and labels
+
+jobs:
+  check-pr-title:
+    name: Check PR Title
+    runs-on: ubuntu-latest
+    steps:
+      - name: Enforce conventional commit style
+        uses: realm/ci-actions/title-checker@d6cc8f067474759d38e6d24e272027b4c88bc0a9
+        with:
+          regex: '^(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test|ops){1}(\([\w\-\.]+\))?(!)?: .*'
+          error-hint: 'Invalid PR title. Make sure it follows the conventional commit specification (i.e. "<type>(<optional scope>): <description>") or add the no-title-validation label'
+          ignore-labels: "no-title-validation"

package/.github/workflows/{lint.yml → 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"

package/.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
@@ -112,5 +92,3 @@ jobs:
         uses: coverallsapp/github-action@v2.3.6
         with:
           file: coverage/lcov.info
-          git-branch: ${{ github.head_ref || github.ref_name }}
-          git-commit: ${{ github.event.pull_request.head.sha || github.sha }}

package/.github/workflows/code_health_fork.yaml

@@ -11,9 +11,14 @@ jobs:
   run-tests:
     name: Run MongoDB tests
     if: github.event.pull_request.user.login == 'dependabot[bot]' || github.event.pull_request.head.repo.full_name != github.repository
-    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+      fail-fast: false
+    runs-on: ${{ matrix.os }}
     steps:
       - uses: GitHubSecurityLab/actions-permissions/monitor@v1
+        if: matrix.os != 'windows-latest'
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
@@ -24,71 +29,12 @@ jobs:
       - name: Run tests
         run: npm test
       - name: Upload test results
-        if: always()
+        if: always() && matrix.os == 'ubuntu-latest'
         uses: actions/upload-artifact@v4
         with:
           name: test-results
           path: coverage/lcov.info
 
-  run-atlas-tests:
-    name: Run Atlas tests
-    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
-        run: npm ci
-      - name: Run tests
-        env:
-          MDB_MCP_API_CLIENT_ID: ${{ secrets.TEST_ATLAS_CLIENT_ID }}
-          MDB_MCP_API_CLIENT_SECRET: ${{ secrets.TEST_ATLAS_CLIENT_SECRET }}
-          MDB_MCP_API_BASE_URL: ${{ vars.TEST_ATLAS_BASE_URL }}
-        run: npm test -- --testPathIgnorePatterns "tests/integration/tools/mongodb" --testPathIgnorePatterns "tests/integration/[^/]+\.ts"
-      - name: Upload test results
-        uses: actions/upload-artifact@v4
-        if: always()
-        with:
-          name: atlas-test-results
-          path: coverage/lcov.info
-
-  coverage:
-    name: Report Coverage
-    if: always() && github.event.pull_request.user.login == 'dependabot[bot]' || github.event.pull_request.head.repo.full_name != github.repository
-    runs-on: ubuntu-latest
-    needs: [run-tests, run-atlas-tests]
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version-file: package.json
-          cache: "npm"
-      - name: Install dependencies
-        run: npm ci
-      - name: Download test results
-        uses: actions/download-artifact@v4
-        with:
-          name: test-results
-          path: coverage/mongodb
-      - name: Download atlas test results
-        uses: actions/download-artifact@v4
-        with:
-          name: atlas-test-results
-          path: coverage/atlas
-      - name: Merge coverage reports
-        run: |
-          npx -y lcov-result-merger@5.0.1 "coverage/*/lcov.info" "coverage/lcov.info"
-      - name: Coveralls GitHub Action
-        uses: coverallsapp/github-action@v2.3.6
-        with:
-          file: coverage/lcov.info
-          git-branch: ${{ github.head_ref || github.ref_name }}
-          git-commit: ${{ github.event.pull_request.head.sha || github.sha }}
-
   merge-dependabot-pr:
     name: Merge Dependabot PR
     if: github.event.pull_request.user.login == 'dependabot[bot]'
@@ -96,8 +42,6 @@ jobs:
     permissions:
       pull-requests: write
       contents: write
-    needs:
-      - coverage
     steps:
       - name: Enable auto-merge for Dependabot PRs
         run: gh pr merge --auto --squash "$PR_URL"

package/.github/workflows/docker.yaml

@@ -0,0 +1,57 @@
+name: Daily Release Docker Image
+on:
+  schedule:
+    - cron: "0 1 * * *" # Every day at 1:00 AM
+  workflow_dispatch: # Run the action manually
+permissions:
+  contents: read
+  issues: write
+jobs:
+  push:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: GitHubSecurityLab/actions-permissions/monitor@v1
+        with:
+          config: ${{ vars.PERMISSIONS_CONFIG }}
+      - name: Check out code
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@18ce135bb5112fa8ce4ed6c17ab05699d7f3a5e0
+      - name: Login to Docker Hub
+        uses: docker/login-action@74a5d142397b4f367a81961eba4e8cd7edddf772
+        with:
+          username: "${{ secrets.DOCKERHUB_USERNAME }}"
+          password: "${{ secrets.DOCKERHUB_PASSWORD }}"
+      - name: Set date and version
+        id: set-properties
+        run: |
+          DATE=$(date +'%Y-%m-%d')
+          VERSION=$(npm pkg get version | tr -d '"')
+          echo "DATE=${DATE}" >> "$GITHUB_OUTPUT"
+          echo "VERSION=${VERSION}" >> "$GITHUB_OUTPUT"
+      - name: Build and push image to dockerhub registry
+        uses: docker/build-push-action@263435318d21b8e681c14492fe198d362a7d2c83
+        with:
+          context: .
+          platforms: linux/amd64,linux/arm64
+          tags: ${{ vars.DOCKERHUB_IMAGE_REPOSITORY }}:latest, ${{ vars.DOCKERHUB_IMAGE_REPOSITORY }}:${{ steps.set-properties.outputs.VERSION }}, ${{ vars.DOCKERHUB_IMAGE_REPOSITORY }}:${{ steps.set-properties.outputs.VERSION }}-${{ steps.set-properties.outputs.DATE }}
+          file: Dockerfile
+          push: true
+          provenance: mode=max
+          sbom: true
+          build-args: |
+            VERSION=${{ steps.set-properties.outputs.VERSION }}
+      - uses: mongodb-js/devtools-shared/actions/setup-bot-token@main
+        id: app-token
+        if: ${{ failure() }}
+        with:
+          app-id: ${{ vars.DEVTOOLS_BOT_APP_ID }}
+          private-key: ${{ secrets.DEVTOOLS_BOT_PRIVATE_KEY }}
+      - name: Create Issue
+        if: ${{ failure() }}
+        uses: imjohnbo/issue-bot@572eed14422c4d6ca37e870f97e7da209422f5bd
+        with:
+          token: ${{ steps.app-token.outputs.token }}
+          title: Release Failure for Docker Image ${{ steps.set-properties.outputs.VERSION }}-${{ steps.set-properties.outputs.DATE }}
+          body: See https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}
+          labels: "docker, release_failure"

package/.github/workflows/stale.yml

@@ -0,0 +1,32 @@
+---
+name: "Stale issues and PRs handler"
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "0 0 * * *"
+
+permissions: read-all
+
+jobs:
+  stale:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+    steps:
+      - uses: GitHubSecurityLab/actions-permissions/monitor@v1
+      - uses: actions/stale@v9
+        id: stale
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          stale-issue-message: |
+            This issue has gone 30 days without any activity and meets the project's definition of "stale". This will be auto-closed if there is no new activity over the next 30 days. If the issue is still relevant and active, you can simply comment with a "bump" to keep it open, or add the label "not_stale". Thanks for keeping our repository healthy!
+          stale-pr-message: |
+            This PR has gone 30 days without any activity and meets the project's definition of "stale". This will be auto-closed if there is no new activity over the next 30 days. If the issue is still relevant and active, you can simply comment with a "bump" to keep it open, or add the label "not_stale". Thanks for keeping our repository healthy!
+          stale-issue-label: "no-issue-activity"
+          stale-pr-label: "no-pr-activity"
+          days-before-stale: 30
+          days-before-close: 30
+          exempt-all-milestones: true
+          exempt-issue-labels: "not_stale"
+          exempt-pr-labels: "not_stale"

package/.smithery/Dockerfile

@@ -0,0 +1,30 @@
+# Generated by https://smithery.ai. See: https://smithery.ai/docs/config#dockerfile
+# ----- Build Stage -----
+FROM node:lts-alpine AS builder
+WORKDIR /app
+
+# Copy package and configuration
+COPY ../package.json ../package-lock.json ../tsconfig.json ../tsconfig.build.json ./
+
+# Copy source code
+COPY ../src ./src
+
+# Install dependencies and build
+RUN npm ci && npm run build
+
+# ----- Production Stage -----
+FROM node:lts-alpine
+
+# Copy built artifacts
+COPY --from=builder /app/dist ./dist
+
+# Copy package.json for production install
+COPY ../package.json ../package-lock.json ./
+
+# Install only production dependencies
+RUN npm ci --production --ignore-scripts
+
+# Expose no ports (stdio only)
+
+# Default command
+CMD ["node", "dist/index.js"]

package/.smithery/smithery.yaml

@@ -0,0 +1,63 @@
+# Smithery.ai configuration
+build:
+  dockerfile: Dockerfile
+  dockerBuildPath: ../
+startCommand:
+  type: stdio
+  configSchema:
+    type: object
+    properties:
+      atlasClientId:
+        type: string
+        title: Atlas Client Id
+        description: Atlas API client ID for authentication. Required for running Atlas tools.
+      atlasClientSecret:
+        type: string
+        title: Atlas Client Secret
+        description: Atlas API client secret for authentication. Required for running Atlas tools.
+      connectionString:
+        type: string
+        title: MongoDB Connection string
+        description: MongoDB connection string for direct database connections. Optional, if not set, you'll need to call the `connect` tool before interacting with MongoDB data.
+      readOnly:
+        type: boolean
+        title: Read-only
+        description: When set to true, only allows read and metadata operation types, disabling create/update/delete operations.
+        default: false
+  exampleConfig:
+    atlasClientId: YOUR_ATLAS_CLIENT_ID
+    atlasClientSecret: YOUR_ATLAS_CLIENT_SECRET
+    connectionString: mongodb+srv://USERNAME:PASSWORD@YOUR_CLUSTER.mongodb.net
+    readOnly: true
+
+  commandFunction:
+    # A function that produces the CLI command to start the MCP on stdio.
+    |-
+    (config) => {
+      const args = ['dist/index.js'];
+      if (config) {
+        if (config.atlasClientId) {
+          args.push('--apiClientId');
+          args.push(config.atlasClientId);
+        }
+
+        if (config.atlasClientSecret) {
+          args.push('--apiClientSecret');
+          args.push(config.atlasClientSecret);
+        }
+
+        if (config.readOnly) {
+          args.push('--readOnly');
+        }
+
+        if (config.connectionString) {
+          args.push('--connectionString');
+          args.push(config.connectionString);
+        }
+      }
+
+      return {
+        command: "node",
+        args
+      };
+    }

package/.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": []
+}

package/.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"
+    ]
+  }
+}

package/CONTRIBUTING.md

@@ -55,7 +55,7 @@ This project implements a Model Context Protocol (MCP) server for MongoDB and Mo
    npm run inspect
    ```
 
-4. Commit your changes with a descriptive commit message
+4. Commit your changes using [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) format.
 
 ## Adding tests to the MCP Server
 

package/Dockerfile

@@ -0,0 +1,10 @@
+FROM node:22-alpine
+ARG VERSION=latest
+RUN addgroup -S mcp && adduser -S mcp -G mcp
+RUN npm install -g mongodb-mcp-server@${VERSION}
+USER mcp
+WORKDIR /home/mcp
+ENTRYPOINT ["mongodb-mcp-server"]
+LABEL maintainer="MongoDB Inc <info@mongodb.com>"
+LABEL description="MongoDB MCP Server"
+LABEL version=${VERSION}