Skip to content

Commit 0bdfc03

Browse files
committed
Update readme
1 parent 746bb93 commit 0bdfc03

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

README.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -166,12 +166,33 @@ The MongoDB MCP Server can be configured using multiple methods, with the follow
166166
| `apiClientSecret` | Atlas API client secret for authentication |
167167
| `connectionString` | MongoDB connection string for direct database connections (optional users may choose to inform it on every tool call) |
168168
| `logPath` | Folder to store logs |
169+
| `disabledTools` | An array of tool names, operation types, and/or categories of tools that will be disabled. |
169170

170-
**Default Log Path:**
171-
171+
#### `logPath`
172+
Default log location is as follows:
172173
- Windows: `%LOCALAPPDATA%\mongodb\mongodb-mcp\.app-logs`
173174
- macOS/Linux: `~/.mongodb/mongodb-mcp/.app-logs`
174175

176+
177+
#### Disabled Tools
178+
You can disable specific tools or categories of tools by using the `disabledTools` option. This option accepts an array of strings,
179+
where each string can be a tool name, operation type, or category.
180+
181+
The way the array is constructed depends on the type of configuration method you use:
182+
- For **environment variable** configuration, use a comma-separated string: `export MDB_MCP_DISABLED_TOOLS="create,update,delete,atlas,collectionSchema"`.
183+
- For **command-line argument** configuration, use a space-separated string: `--disabledTools create update delete atlas collectionSchema`.
184+
185+
Categories of tools:
186+
- `atlas` - MongoDB Atlas tools, such as list clusters, create cluster, etc.
187+
- `mongodb` - MongoDB database tools, such as find, aggregate, etc.
188+
189+
Operation types:
190+
- `create` - Tools that create resources, such as create cluster, insert document, etc.
191+
- `update` - Tools that update resources, such as update document, rename collection, etc.
192+
- `delete` - Tools that delete resources, such as delete document, drop collection, etc.
193+
- `read` - Tools that read resources, such as find, aggregate, list clusters, etc.
194+
- `metadata` - Tools that read metadata, such as list databases, list collections, collection schema, etc.
195+
175196
### Atlas API Access
176197

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

0 commit comments

Comments
 (0)