Skip to content

Commit 9a8c605

Browse files
chore: update readme with the new tool and resources
1 parent 4314bc3 commit 9a8c605

File tree

4 files changed

+11
-4
lines changed

4 files changed

+11
-4
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,7 @@ npx -y mongodb-mcp-server@latest --transport http --httpHost=0.0.0.0 --httpPort=
262262

263263
> **Note:** The default transport is `stdio`, which is suitable for integration with most MCP clients. Use `http` transport if you need to interact with the server over HTTP.
264264
265-
## 🛠️ Supported Tools
265+
## Supported Tools
266266

267267
### Tool List
268268

@@ -305,6 +305,13 @@ NOTE: atlas tools are only available when you set credentials on [configuration]
305305
- `collection-schema` - Describe the schema for a collection
306306
- `collection-storage-size` - Get the size of a collection in MB
307307
- `db-stats` - Return statistics about a MongoDB database
308+
- `export` - Export a query or aggregation results in the specified EJSON format.
309+
310+
## Supported Resources
311+
312+
- `config` - Server configuration, supplied by the user either as environment variables or as startup arguments with sensitive parameters redacted. The resource can be accessed under URI `config://config`.
313+
- `debug` - Debugging information for MongoDB connectivity issues. Tracks the last connectivity attempt and error information. The resource can be accessed under URI `debug://mongodb`.
314+
- `exported-data` - A resource template to access the data exported using the export tool. The template can be accessed under URI `exported-data://{exportName}` where `exportName` is the unique name for an export generated by the export tool.
308315

309316
## Configuration
310317

src/resources/common/debug.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ export class DebugResource extends ReactiveResource<
2121
uri: "debug://mongodb",
2222
config: {
2323
description:
24-
"Debugging information for MongoDB connectivity issues. Tracks the last connectivity error and attempt information.",
24+
"Debugging information for MongoDB connectivity issues. Tracks the last connectivity attempt and error information.",
2525
},
2626
},
2727
options: {

src/tools/mongodb/read/export.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import { AggregateArgs } from "./aggregate.js";
1010

1111
export class ExportTool extends MongoDBToolBase {
1212
public name = "export";
13-
protected description = "Export a collection data or query results in the specified EJSON format.";
13+
protected description = "Export a query or aggregation results in the specified EJSON format.";
1414
protected argsShape = {
1515
...DbOperationArgs,
1616
exportTitle: z.string().describe("A short description to uniquely identify the export."),

tests/integration/tools/mongodb/read/export.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ describeWithMongoDB(
5353
validateToolMetadata(
5454
integration,
5555
"export",
56-
"Export a collection data or query results in the specified EJSON format.",
56+
"Export a query or aggregation results in the specified EJSON format.",
5757
[
5858
...databaseCollectionParameters,
5959
{

0 commit comments

Comments
 (0)