mongodb-mcp-server 0.0.4

package/.github/workflows/code_health.yaml

@@ -0,0 +1,65 @@
+---
+name: Code Health
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+jobs:
+  check-style:
+    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 style check
+        run: npm run check
+
+  check-generate:
+    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 style check
+        run: npm run generate
+
+  run-tests:
+    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:
+          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
+      - name: Coveralls GitHub Action
+        uses: coverallsapp/github-action@v2.3.6
+        if: matrix.os == 'ubuntu-latest'
+        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/prepare_release.yaml

@@ -0,0 +1,45 @@
+name: Prepare release
+description: |
+  Bumps the version in package.json and creates a release PR. Once merged, the new
+  version will be published to npm.
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: "Exact version to bump to or one of major, minor, patch"
+        required: true
+        default: "patch"
+
+jobs:
+  create-pr:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: mongodb-js/devtools-shared/actions/setup-bot-token@main
+        id: app-token
+        with:
+          app-id: ${{ vars.DEVTOOLS_BOT_APP_ID }}
+          private-key: ${{ secrets.DEVTOOLS_BOT_PRIVATE_KEY }}
+      - uses: GitHubSecurityLab/actions-permissions/monitor@v1
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: package.json
+          registry-url: "https://registry.npmjs.org"
+          cache: "npm"
+      - name: Bump version
+        id: bump-version
+        run: |
+          echo "NEW_VERSION=$(npm version ${{ inputs.version }} --no-git-tag-version)" >> $GITHUB_OUTPUT
+      - name: Create release PR
+        uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # 7.0.8
+        with:
+          title: "Release v${{ steps.bump-version.outputs.NEW_VERSION }}"
+          token: ${{ steps.app-token.outputs.token }}
+          commit-message: "Bump version to v${{ steps.bump-version.outputs.NEW_VERSION }}"
+          body: |
+            This PR bumps the package version to v${{ steps.bump-version.outputs.NEW_VERSION }}.
+            Once merged, the new version will be published to npm.
+          base: main
+          branch: release/v${{ steps.bump-version.outputs.NEW_VERSION }}
+          author: "${{ steps.app-token.outputs.app-slug}}[bot] <${{ steps.app-token.outputs.app-email }}>"
+          committer: "${{ steps.app-token.outputs.app-slug}}[bot] <${{ steps.app-token.outputs.app-email }}>"

package/.github/workflows/publish.yaml

@@ -0,0 +1,70 @@
+---
+name: Publish
+on:
+  push:
+    branches:
+      - main
+permissions:
+  contents: write
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    outputs:
+      VERSION_EXISTS: ${{ steps.check-version.outputs.VERSION_EXISTS }}
+      VERSION: ${{ steps.get-version.outputs.VERSION }}
+    steps:
+      - uses: GitHubSecurityLab/actions-permissions/monitor@v1
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: package.json
+          registry-url: "https://registry.npmjs.org"
+          cache: "npm"
+      - name: Get version
+        id: get-version
+        shell: bash
+        run: |
+          set +e
+
+          VERSION=v$(jq -r '.version' < package.json)
+          echo "VERSION=${VERSION}" >> "$GITHUB_OUTPUT"
+      - name: Check if version already exists
+        id: check-version
+        shell: bash
+        run: |
+          set +e
+
+          git rev-parse "${{ steps.get-version.outputs.VERSION }}" >/dev/null 2>&1
+          if [[ $? -eq 0 ]]; then
+            echo "VERSION_EXISTS=true" >> "$GITHUB_OUTPUT"
+          else
+            echo "VERSION_EXISTS=false" >> "$GITHUB_OUTPUT"
+          fi
+  publish:
+    runs-on: ubuntu-latest
+    environment: Production
+    needs: check
+    if: needs.check.outputs.VERSION_EXISTS == 'false'
+    steps:
+      - uses: GitHubSecurityLab/actions-permissions/monitor@v1
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: package.json
+          registry-url: "https://registry.npmjs.org"
+          cache: "npm"
+      - name: Build package
+        run: |
+          npm ci
+          npm run build
+      - name: Publish to NPM
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - name: Publish git release
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          gh release create ${{ needs.check.outputs.VERSION }} --title "${{ needs.check.outputs.VERSION }}" --generate-notes --target ${{ github.sha }}

package/.prettierignore

@@ -0,0 +1,5 @@
+dist
+coverage
+package-lock.json
+tests/tmp
+src/common/atlas/openapi.d.ts

package/.prettierrc.json

@@ -0,0 +1,37 @@
+{
+  "trailingComma": "es5",
+  "tabWidth": 4,
+  "semi": true,
+  "singleQuote": false,
+  "printWidth": 120,
+  "overrides": [
+    {
+      "files": "*.ts",
+      "options": {
+        "insertPragma": false,
+        "proseWrap": "preserve"
+      }
+    },
+    {
+      "files": "*.json",
+      "options": {
+        "tabWidth": 2,
+        "printWidth": 80
+      }
+    },
+    {
+      "files": "*.md",
+      "options": {
+        "tabWidth": 2,
+        "printWidth": 80
+      }
+    },
+    {
+      "files": "*.yaml",
+      "options": {
+        "tabWidth": 2,
+        "printWidth": 80
+      }
+    }
+  ]
+}

package/.vscode/launch.json

@@ -0,0 +1,17 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Launch Program",
+      "skipFiles": ["<node_internals>/**"],
+      "program": "${workspaceFolder}/dist/index.js",
+      "preLaunchTask": "tsc: build - tsconfig.json",
+      "outFiles": ["${workspaceFolder}/dist/**/*.js"]
+    }
+  ]
+}

package/CONTRIBUTING.md

@@ -0,0 +1,185 @@
+# Contributing to MongoDB MCP Server
+
+Thank you for your interest in contributing to the MongoDB MCP Server project! This document provides guidelines and instructions for contributing.
+
+## Project Overview
+
+This project implements a Model Context Protocol (MCP) server for MongoDB and MongoDB Atlas, enabling AI assistants to interact with MongoDB Atlas resources through natural language.
+
+## Development Setup
+
+### Prerequisites
+
+- Node.js (v20 or later)
+- npm
+
+### Getting Started
+
+1. Clone the repository:
+
+   ```
+   git clone https://github.com/mongodb-labs/mongodb-mcp-server.git
+   cd mongodb-mcp-server
+   ```
+
+2. Install dependencies:
+
+   ```
+   npm install
+   ```
+
+3. Add the mcp server to your IDE of choice (see the [README](README.md) for detailed client integration instructions)
+   ```json
+   {
+     "mcpServers": {
+       "MongoDB": {
+         "command": "/path/to/mongodb-mcp-server/dist/index.js"
+       }
+     }
+   }
+   ```
+
+## Code Contribution Workflow
+
+1. Create a new branch for your feature or bugfix:
+
+   ```
+   git checkout -b feature/your-feature-name
+   ```
+
+2. Make your changes, following the code style of the project
+
+3. Run the inspector and double check your changes:
+
+   ```
+   npm run inspect
+   ```
+
+4. Commit your changes with a descriptive commit message
+
+## Adding tests to the MCP Server
+
+When adding new features or fixing bugs, please ensure that you also add tests to cover your changes. This helps maintain the quality and reliability of the codebase.
+
+## Running Tests
+
+The tests can be found in the `tests` directory.
+
+You can run tests using the following npm scripts:
+
+- `npm test`: Run all tests
+
+To run a specific test file or directory:
+
+```bash
+npm test -- path/to/test/file.test.ts
+npm test -- path/to/directory
+```
+
+## Troubleshooting
+
+### Restart Server
+
+- Run `npm run build` to re-build the server if you made changes to the code
+- Press `Cmd + Shift + P` and type List MCP Servers
+- Select the MCP server you want to restart
+- Select the option to restart the server
+
+### View Logs
+
+To see MCP logs, check https://code.visualstudio.com/docs/copilot/chat/mcp-servers.
+
+- Press `Cmd + Shift + P` and type List MCP Servers
+- Select the MCP server you want to see logs for
+- Select the option to view logs in the output panel
+
+### Debugging
+
+For debugging, we use the MCP inspector tool. From the root of this repository, run:
+
+```shell
+npm run inspect
+```
+
+This is equivalent to:
+
+```shell
+npx @modelcontextprotocol/inspector -- node dist/index.js
+```
+
+## Pull Request Guidelines
+
+1. Update documentation if necessary
+2. Ensure your PR includes only relevant changes
+3. Link any related issues in your PR description
+4. Keep PRs focused on a single topic
+
+## Code Standards
+
+- Use TypeScript for all new code
+- Follow the existing code style (indentation, naming conventions, etc.)
+- Comment your code when necessary, especially for complex logic
+- Use meaningful variable and function names
+
+## Reporting Issues
+
+When reporting issues, please include:
+
+- A clear description of the problem
+- Steps to reproduce
+- Expected vs. actual behavior
+- Version information
+- Environment details
+
+## Adding New Tools
+
+When adding new tools to the MCP server:
+
+1. Follow the existing pattern in `server.ts`
+2. Define clear parameter schemas using Zod
+3. Implement thorough error handling
+4. Add proper documentation for the tool
+5. Include examples of how to use the tool
+
+## Release Process
+
+Our release process is automated using GitHub Actions workflows:
+
+### Version Bumping
+
+1. To create a new version, go to the GitHub repository Actions tab
+2. Select the "Version Bump" workflow
+3. Click "Run workflow" and choose one of the following options:
+   - `patch` (e.g., 1.0.0 → 1.0.1) for backward-compatible bug fixes
+   - `minor` (e.g., 1.0.0 → 1.1.0) for backward-compatible new features
+   - `major` (e.g., 1.0.0 → 2.0.0) for breaking changes
+   - A specific version number (e.g., `1.2.3`)
+4. This creates a pull request with the version change
+5. Once approved and merged, the version is updated
+
+### Automatic Publishing
+
+When a version bump is merged to the main branch:
+
+1. The "Publish" workflow automatically runs
+2. It checks if the version already exists as a git tag
+3. If the version is new, it:
+   - Builds the package
+   - Publishes to NPM
+   - Creates a git tag for the version
+   - Creates a GitHub release with auto-generated release notes
+
+### Code Quality
+
+All pull requests automatically run through the "Code Health" workflow, which:
+
+- Verifies code style and formatting
+- Runs tests on multiple platforms (Ubuntu, macOS, Windows)
+
+## License
+
+By contributing to this project, you agree that your contributions will be licensed under the project's license.
+
+## Questions?
+
+If you have any questions or need help, please open an issue or reach out to the maintainers.

package/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.