Skip to content

Commit fcd62b6

Browse files
authored
chore: add docs about different type of roles (#284)
1 parent 60d2464 commit fcd62b6

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ node -v
3636

3737
### Quick Start
3838

39+
> **Note:** When using Atlas API credentials, be sure to assign only the minimum required permissions to your service account. See [Atlas API Permissions](#atlas-api-permissions) for details.
40+
3941
Most MCP clients require a configuration file to be created or modified to add the MCP server.
4042

4143
Note: The configuration file syntax can be different across clients. Please refer to the following links for the latest expected syntax:
@@ -320,13 +322,16 @@ You can disable telemetry using:
320322

321323
To use the Atlas API tools, you'll need to create a service account in MongoDB Atlas:
322324

325+
> **ℹ️ Note:** For a detailed breakdown of the minimum required permissions for each Atlas operation, see the [Atlas API Permissions](#atlas-api-permissions) section below.
326+
323327
1. **Create a Service Account:**
324328

325329
- Log in to MongoDB Atlas at [cloud.mongodb.com](https://cloud.mongodb.com)
326330
- Navigate to Access Manager > Organization Access
327331
- Click Add New > Applications > Service Accounts
328332
- Enter name, description and expiration for your service account (e.g., "MCP, MCP Server Access, 7 days")
329-
- Select appropriate permissions (for full access, use Organization Owner)
333+
- **Assign only the minimum permissions needed for your use case.**
334+
- See [Atlas API Permissions](#atlas-api-permissions) for details.
330335
- Click "Create"
331336

332337
To learn more about Service Accounts, check the [MongoDB Atlas documentation](https://www.mongodb.com/docs/atlas/api/service-accounts-overview/).
@@ -343,6 +348,26 @@ To learn more about Service Accounts, check the [MongoDB Atlas documentation](ht
343348
4. **Configure the MCP Server:**
344349
- Use one of the configuration methods below to set your `apiClientId` and `apiClientSecret`
345350

351+
### Atlas API Permissions
352+
353+
> **Security Warning:** Granting the Organization Owner role is rarely necessary and can be a security risk. Assign only the minimum permissions needed for your use case.
354+
355+
#### Quick Reference: Required roles per operation
356+
357+
| What you want to do | Safest Role to Assign (where) |
358+
| ------------------------------------ | --------------------------------------- |
359+
| List orgs/projects | Org Member or Org Read Only (Org) |
360+
| Create new projects | Org Project Creator (Org) |
361+
| View clusters/databases in a project | Project Read Only (Project) |
362+
| Create/manage clusters in a project | Project Cluster Manager (Project) |
363+
| Manage project access lists | Project IP Access List Admin (Project) |
364+
| Manage database users | Project Database Access Admin (Project) |
365+
366+
- **Prefer project-level roles** for most operations. Assign only to the specific projects you need to manage or view.
367+
- **Avoid Organization Owner** unless you require full administrative control over all projects and settings in the organization.
368+
369+
For a full list of roles and their privileges, see the [Atlas User Roles documentation](https://www.mongodb.com/docs/atlas/reference/user-roles/#service-user-roles).
370+
346371
### Configuration Methods
347372

348373
#### Environment Variables

0 commit comments

Comments
 (0)