Atlas MCP Server Wr3

🚀 MongoDB MCP Server

The MongoDB MCP (MongoDB Command Line Process) Server is a powerful tool that supports managing MongoDB databases and Atlas cloud services through the command-line interface. Below is a detailed list of its functions and usage instructions.

🚀 Quick Start

✨ Features

Tool List

MCP offers the following core tools:

• MongoDB Shell: Interact directly with MongoDB databases.
• mongodump/mongorestore: Backup and restore databases.
• mongoexport/mongoimport: Import and export data.
• dbstats: Query database statistical information.
• replSetCommand: Perform replica set operations.
• Atlas API Tools: Manage MongoDB Atlas resources.

Atlas API Tool List

The following are Atlas-related commands provided by MCP:

• mongoatlas clusters list: List all clusters.
• mongoatlas projects list: List all projects.
• mongoatlas dbs.list: Get the database list.
• mongoatlas users.list: Get the user list.
• mongoatlas metrics.getClusterMetrics: Get cluster performance metrics.

📦 Installation

Environment Variable Configuration

When setting environment variables, use the prefix MDB_MCP_ followed by the uppercase option name:

# 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 a custom MongoDB connection string
export MDB_MCP_CONNECTION_STRING="mongodb+srv://username:password@cluster.mongodb.net/myDatabase"

# Set the log path
export MDB_MCP_LOG_PATH="/path/to/logs"

MCP Configuration File Examples

Connection String Configuration Using Environment Variables:

{
  "mcpServers": {
    "MongoDB": {
      "command": "npx",
      "args": ["-y", "mongodb-mcp-server"],
      "env": {
        "MDB_MCP_CONNECTION_STRING": "mongodb+srv://username:password@cluster.mongodb.net/myDatabase"
      }
    }
  }
}

Atlas API Credential Configuration Using Environment Variables:

{
  "mcpServers": {
    "MongoDB": {
      "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"
      }
    }
  }
}

Command-Line Parameter Configuration

Pass configuration options via the command line:

npx -y mongodb-mcp-server --apiClientId="your-atlas-client-id" --apiClientSecret="your-atlas-client-secret" --connectionString="mongodb+srv://username:password@cluster.mongodb.net/myDatabase" --logPath=/path/to/logs

MCP Configuration File Examples

Connection String Configuration Using Command-Line Parameters:

{
  "mcpServers": {
    "MongoDB": {
      "command": "npx",
      "args": [
        "-y",
        "mongodb-mcp-server",
        "--connectionString",
        "mongodb+srv://username:password@cluster.mongodb.net/myDatabase"
      ]
    }
  }
}

Atlas API Credential Configuration Using Command-Line Parameters:

{
  "mcpServers": {
    "MongoDB": {
      "command": "npx",
      "args": [
        "-y",
        "mongodb-mcp-server",
        "--apiClientId",
        "your-atlas-client-id",
        "--apiClientSecret",
        "your-atlas-client-secret"
      ]
    }
  }
}

📚 Documentation

Using the Atlas API

Creating a MongoDB Atlas User

Use the following command to create a user:

mongoatlas users.create --projectId <PROJECT_ID> \
--email <EMAIL> \
--username <USERNAME> \
--password <PASSWORD>

Obtaining MongoDB Atlas Database Access

The command to obtain read and write access to a database is as follows:

mongoatlas dbusers.grantAccess --projectId <PROJECT_ID> \
--db <DATABASE_NAME> \
--user <USERNAME>

Contributing to the Project

If you wish to contribute to the MongoDB MCP project, please follow these steps:

1. Clone the repository:

   git clone https://github.com/mongodb/mongo-mcp.git
   

2. Install dependencies:

   npm install
   

3. Run tests:

   npm test
   

Reporting Issues

If you encounter any issues, please visit the MongoDB MCP project homepage to submit an issue.

Appendix: Examples of Common Commands

Creating a New Database

mongo --db <DATABASE_NAME> --eval 'db.createDatabase(<DATABASE_NAME>)'

Deleting a Specified Database

mongo --db <DATABASE_NAME> --eval 'db.dropDatabase()'

MongoDB Backup

mongodump --db <DATABASE_NAME> --out /path/to/backup

MongoDB Restoration

mongorestore --db <DATABASE_NAME> /path/to/backup/<DATABASE_NAME>. BSON

For more information, please refer to the official documentation or contact technical support.