MongoDB Atlas MCP Server

1# MongoDB Atlas MCP Server
2 
3A Model Context Protocol (MCP) server that provides access to the MongoDB Atlas API. This server wraps the [mongodb-atlas-api-client](https://www.npmjs.com/package/mongodb-atlas-api-client) package to expose MongoDB Atlas functionality through MCP tools.
4 
5## Features
6 
7This MCP server exposes most of the mongodb-atlas-api-client surface as MCP tools.
8 
9### Database Users
10- `user_get` — Get a database user by username
11- `user_get_all` — List all database users
12- `user_create` — Create a database user
13- `user_update` — Update a database user
14- `user_delete` — Delete a database user
15 
16### Clusters
17- `cluster_get` — Get cluster details
18- `cluster_get_all` — List clusters
19- `cluster_create` — Create cluster
20- `cluster_update` — Update cluster
21- `cluster_delete` — Delete cluster
22- `cluster_get_advanced_configuration` — Get processArgs (advanced config)
23- `cluster_update_advanced_configuration` — Update processArgs (advanced config)
24- `cluster_test_primary_failover` — Initiate a test primary failover
25 
26### Projects
27- `project_get_by_id` — Get project by ID
28- `project_get_by_name` — Get project by name
29- `project_get_all` — List projects
30- `project_create` — Create project
31- `project_delete` — Delete project
32- `project_get_teams` — List teams for a project
33- `project_remove_user` — Remove a user from a project
34- `project_assign_teams` — Assign teams to a project
35 
36### Cloud Backups
37- `cloud_backup_get_snapshots` — List cloud backup snapshots (replicaset)
38- `cloud_backup_get_snapshot` — Get a specific snapshot
39- `cloud_backup_get_restore_job` — Get a snapshot restore job
40- `cloud_backup_create_restore_job` — Create a snapshot restore job
41 
42### Organizations
43- `organization_get_by_id` — Get organization by ID
44- `organization_get_all` — List organizations
45- `organization_get_users` — List users in an organization
46- `organization_get_projects` — List projects in an organization
47- `organization_delete` — Delete organization
48- `organization_rename` — Rename organization
49- `organization_invite` — Invite users to organization
50 
51### Project Access Lists (current)
52- `project_access_list_get_all` — List IP access list entries
53- `project_access_list_get` — Get a specific access list entry
54- `project_access_list_create` — Add entries to access list
55- `project_access_list_update` — Upsert access list entries (POST semantics)
56- `project_access_list_delete` — Delete an access list entry
57 
58### Project Whitelist (legacy)
59- `project_whitelist_get_all` — List whitelist entries
60- `project_whitelist_get` — Get a whitelist entry
61- `project_whitelist_create` — Add whitelist entries
62- `project_whitelist_update` — Update whitelist entries
63- `project_whitelist_delete` — Delete a whitelist entry
64 
65### Events
66- `events_get_all` — List project events
67- `events_get` — Get event by ID (project scope)
68- `events_get_by_org` — Get event by ID for an organization
69- `events_get_all_by_org` — List organization events
70 
71### Atlas Search
72- `atlas_search_get_all` — List indexes for a collection
73- `atlas_search_create` — Create an index
74- `atlas_search_get` — Get index by ID
75- `atlas_search_update` — Update index by ID
76- `atlas_search_delete` — Delete index by ID
77- `atlas_search_get_all_analyzers` — List analyzers
78- `atlas_search_upsert_analyzer` — Create/Update analyzers
79 
80### Atlas Users (Account-level)
81- `atlas_user_get_by_name` — Get Atlas user by username
82- `atlas_user_get_by_id` — Get Atlas user by ID
83- `atlas_user_get_all` — List Atlas users for the project
84- `atlas_user_create` — Create Atlas user
85- `atlas_user_update` — Update Atlas user
86 
87### Alerts
88- `alert_get_all` — List project alerts
89- `alert_get` — Get alert by ID
90- `alert_acknowledge` — Acknowledge alert
91 
92### Data Lake
93- `datalake_get` — Get Data Lake by name
94- `datalake_get_all` — List Data Lakes
95- `datalake_create` — Create Data Lake
96- `datalake_update` — Update Data Lake
97- `datalake_delete` — Delete Data Lake
98- `datalake_get_logs_stream` — Get query logs (returns base64-encoded gzip data)
99 
100### Cloud Provider Access
101- `cloud_provider_access_get_all` — List cloud provider access roles
102- `cloud_provider_access_create` — Create a role
103- `cloud_provider_access_update` — Update a role (roleId + body)
104- `cloud_provider_access_delete` — Delete a role (cloudProvider + roleId)
105 
106## Installation
107 
1081. Clone this repository:
109```bash
110git clone https://github.com/montumodi/mongodb-atlas-mcp-server.git
111cd mongodb-atlas-mcp-server
112```
113 
1142. Install dependencies:
115```bash
116npm install
117```
118 
119## Configuration
120 
121Before using the server, you need to set up environment variables with your MongoDB Atlas API credentials:
122 
123### Required Environment Variables
124 
125- `MONGODB_ATLAS_PUBLIC_KEY` - Your MongoDB Atlas API public key
126- `MONGODB_ATLAS_PRIVATE_KEY` - Your MongoDB Atlas API private key  
127- `MONGODB_ATLAS_PROJECT_ID` - Your MongoDB Atlas project/group ID
128 
129### Optional Environment Variables
130 
131- `MONGODB_ATLAS_BASE_URL` - Atlas API base URL (defaults to `https://cloud.mongodb.com/api/atlas/v1.0`)
132 
133### Getting Atlas API Keys
134 
1351. Log in to [MongoDB Atlas](https://cloud.mongodb.com/)
1362. Go to **Organization Settings** → **Access Manager** → **API Keys**
1373. Click **Create API Key**
1384. Assign appropriate permissions (Project Read/Write access recommended)
1395. Copy the public and private keys
1406. Find your Project ID in the project settings
141 
142### Example Configuration
143 
144```bash
145export MONGODB_ATLAS_PUBLIC_KEY="your-public-key"
146export MONGODB_ATLAS_PRIVATE_KEY="your-private-key" 
147export MONGODB_ATLAS_PROJECT_ID="your-project-id"
148```
149 
150Or create a `.env` file:
151```env
152MONGODB_ATLAS_PUBLIC_KEY=your-public-key
153MONGODB_ATLAS_PRIVATE_KEY=your-private-key
154MONGODB_ATLAS_PROJECT_ID=your-project-id
155```
156 
157## Usage
158 
159### Running the Server
160 
161```bash
162npm start
163```
164 
165### Using with MCP Clients
166 
167This server implements the Model Context Protocol and can be used with any MCP-compatible client. The server communicates over stdin/stdout.
168 
169### Example Tool Usage
170 
171#### Get All Clusters
172```json
173{
174  "name": "cluster_get_all",
175  "arguments": {
176    "options": {
177      "itemsPerPage": 10
178    }
179  }
180}
181```
182 
183#### Create a Database User
184```json
185{
186  "name": "user_create", 
187  "arguments": {
188    "body": {
189      "username": "newuser",
190      "password": "securepassword123",
191      "roles": [
192        {
193          "databaseName": "myapp",
194          "roleName": "readWrite"
195        }
196      ],
197      "databaseName": "admin"
198    }
199  }
200}
201```
202 
203#### Get Project Events
204#### Get Data Lake Logs (example)
205Note: The logs are returned as base64-encoded gzip data in the `text` response. Decode base64 and then gunzip to read.
206```json
207{
208  "name": "datalake_get_logs_stream",
209  "arguments": { "dataLakeName": "MyDataLake" }
210}
211```
212```json
213{
214  "name": "events_get_all",
215  "arguments": {
216    "options": {
217      "itemsPerPage": 20,
218      "eventType": ["CLUSTER"]
219    }
220  }
221}
222```
223 
224## Error Handling
225 
226The server provides detailed error messages for:
227- Missing or invalid API credentials
228- Network connectivity issues
229- Invalid parameters
230- MongoDB Atlas API errors
231 
232## Development
233 
234### Running in Development Mode
235```bash
236npm run dev
237```
238 
239### Testing
240```bash
241npm test
242```
243 
244## Dependencies
245 
246- **@modelcontextprotocol/sdk** - MCP SDK for server implementation
247- **mongodb-atlas-api-client** - MongoDB Atlas API client library
248 
249## API Reference
250 
251This server exposes MongoDB Atlas API functionality through MCP tools. For detailed information about the underlying Atlas API, refer to:
252 
253- [MongoDB Atlas API Documentation](https://docs.atlas.mongodb.com/reference/api/)
254- [mongodb-atlas-api-client Documentation](https://www.npmjs.com/package/mongodb-atlas-api-client)
255 
256## Contributing
257 
2581. Fork the repository
2592. Create a feature branch
2603. Make your changes
2614. Add tests if applicable
2625. Submit a pull request
263 
264## License
265 
266MIT
267 
268## Support
269 
270For issues and questions:
271- Check the [MongoDB Atlas API Documentation](https://docs.atlas.mongodb.com/reference/api/)
272- Review the [mongodb-atlas-api-client](https://github.com/montumodi/mongodb-atlas-api-client) documentation
273- Open an issue in this repository
274