mongodb-lens

# MongoDB Lens [](./LICENSE) [](https://hub.docker.com/r/furey/mongodb-lens) [](https://www.npmjs.com/package/mongodb-lens) [](https://www.buymeacoffee.com/furey) **MongoDB Lens** is a local Model Context Protocol (MCP) server with full featured access to MongoDB databases using natural language via LLMs to perform queries, run aggregations, optimize performance, and more. ## Contents - [Quick Start](#quick-start) - [Features](#features) - [Installation](#installation) - [Configuration](#configuration) - [Client Setup](#client-setup) - [Data Protection](#data-protection) - [Tutorial](#tutorial) - [Test Suite](#test-suite) - [Disclaimer](#disclaimer) - [Support](#support) ## Quick Start - [Install](#installation) MongoDB Lens - [Configure](#configuration) MongoDB Lens - [Set up](#client-setup) your MCP Client (e.g. [Claude Desktop](#client-setup-claude-desktop), [Cursor](https://docs.cursor.com/context/model-context-protocol#configuring-mcp-servers), etc) - Explore your MongoDB databases with [natural language queries](#tutorial-4-example-queries) ## Features - [Tools](#tools) - [Resources](#resources) - [Prompts](#prompts) - [Other](#other-features) ### Tools - [`add-connection-alias`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27add-connection-alias%27%2C%2F): Add a new MongoDB connection alias - [`aggregate-data`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27aggregate-data%27%2C%2F): Execute aggregation pipelines - [`analyze-query-patterns`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27analyze-query-patterns%27%2C%2F): Analyze live queries and suggest optimizations - [`analyze-schema`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27analyze-schema%27%2C%2F): Automatically infer collection schemas - [`bulk-operations`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27bulk-operations%27%2C%2F): Perform multiple operations efficiently ([requires confirmation](#data-protection-confirmation-for-destructive-operations) for destructive operations) - [`clear-cache`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27clear-cache%27%2C%2F): Clear memory caches to ensure fresh data - [`collation-query`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27collation-query%27%2C%2F): Find documents with language-specific collation rules - [`compare-schemas`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27compare-schemas%27%2C%2F): Compare schemas between two collections - [`connect-mongodb`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27connect-mongodb%27%2C%2F): Connect to a different MongoDB URI - [`connect-original`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27connect-original%27%2C%2F): Connect back to the original MongoDB URI used at startup - [`count-documents`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27count-documents%27%2C%2F): Count documents matching specified criteria - [`create-collection`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27create-collection%27%2C%2F): Create new collections with custom options - [`create-database`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27create-database%27%2C%2F): Create a new database with option to switch to it - [`create-index`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27create-index%27%2C%2F): Create new indexes for performance optimization - [`create-timeseries`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27create-timeseries%27%2C%2F): Create time series collections for temporal data - [`create-user`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27create-user%27%2C%2F): Create new database users with specific roles - [`current-database`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27current-database%27%2C%2F): Show the current database context - [`delete-document`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27delete-document%27%2C%2F): Delete documents matching specified criteria ([requires confirmation](#data-protection-confirmation-for-destructive-operations)) - [`distinct-values`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27distinct-values%27%2C%2F): Extract unique values for any field - [`drop-collection`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27drop-collection%27%2C%2F): Remove collections from the database ([requires confirmation](#data-protection-confirmation-for-destructive-operations)) - [`drop-database`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27drop-database%27%2C%2F): Drop a database ([requires confirmation](#data-protection-confirmation-for-destructive-operations)) - [`drop-index`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27drop-index%27%2C%2F): Remove indexes from collections ([requires confirmation](#data-protection-confirmation-for-destructive-operations)) - [`drop-user`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27drop-user%27%2C%2F): Remove database users ([requires confirmation](#data-protection-confirmation-for-destructive-operations)) - [`explain-query`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27explain-query%27%2C%2F): Analyze query execution plans - [`export-data`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27export-data%27%2C%2F): Export query results in JSON or CSV format - [`find-documents`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27find-documents%27%2C%2F): Run queries with filters, projections, and sorting - [`generate-schema-validator`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27generate-schema-validator%27%2C%2F): Generate JSON Schema validators - [`geo-query`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27geo-query%27%2C%2F): Perform geospatial queries with various operators - [`get-stats`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27get-stats%27%2C%2F): Retrieve database or collection statistics - [`gridfs-operation`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27gridfs-operation%27%2C%2F): Manage large files with GridFS buckets - [`insert-document`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27insert-document%27%2C%2F): Insert one or more documents into collections - [`list-collections`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27list-collections%27%2C%2F): Explore collections in the current database - [`list-connections`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27list-connections%27%2C%2F): View all available MongoDB connection aliases - [`list-databases`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27list-databases%27%2C%2F): View all accessible databases - [`rename-collection`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27rename-collection%27%2C%2F): Rename existing collections ([requires confirmation](#data-protection-confirmation-for-destructive-operations) when dropping targets) - [`shard-status`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27shard-status%27%2C%2F): View sharding configuration for databases and collections - [`text-search`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27text-search%27%2C%2F): Perform full-text search across text-indexed fields - [`transaction`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27transaction%27%2C%2F): Execute multiple operations in a single ACID transaction - [`update-document`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27update-document%27%2C%2F): Update documents matching specified criteria - [`use-database`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27use-database%27%2C%2F): Switch to a specific database context - [`validate-collection`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27validate-collection%27%2C%2F): Check for data inconsistencies - [`watch-changes`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.tool%5C%28%5Cs*%27watch-changes%27%2C%2F): Monitor real-time changes to collections ### Resources - [`collection-indexes`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.resource%5C%28%5Cs*%27collection-indexes%27%2C%2F): Index information for a collection - [`collection-schema`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.resource%5C%28%5Cs*%27collection-schema%27%2C%2F): Schema information for a collection - [`collection-stats`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.resource%5C%28%5Cs*%27collection-stats%27%2C%2F): Performance statistics for a collection - [`collection-validation`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.resource%5C%28%5Cs*%27collection-validation%27%2C%2F): Validation rules for a collection - [`collections`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.resource%5C%28%5Cs*%27collections%27%2C%2F): List of collections in the current database - [`database-triggers`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.resource%5C%28%5Cs*%27database-triggers%27%2C%2F): Database change streams and event triggers configuration - [`database-users`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.resource%5C%28%5Cs*%27database-users%27%2C%2F): Database users and roles in the current database - [`databases`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.resource%5C%28%5Cs*%27databases%27%2C%2F): List of all accessible databases - [`performance-metrics`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.resource%5C%28%5Cs*%27performance-metrics%27%2C%2F): Real-time performance metrics and profiling data - [`replica-status`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.resource%5C%28%5Cs*%27replica-status%27%2C%2F): Replica set status and configuration - [`server-status`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.resource%5C%28%5Cs*%27server-status%27%2C%2F): Server status information - [`stored-functions`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.resource%5C%28%5Cs*%27stored-functions%27%2C%2F): Stored JavaScript functions in the current database ### Prompts - [`aggregation-builder`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.prompt%5C%28%5Cs*%27aggregation-builder%27%2C%2F): Step-by-step creation of aggregation pipelines - [`backup-strategy`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.prompt%5C%28%5Cs*%27backup-strategy%27%2C%2F): Customized backup and recovery recommendations - [`data-modeling`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.prompt%5C%28%5Cs*%27data-modeling%27%2C%2F): Expert advice on MongoDB schema design for specific use cases - [`database-health-check`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.prompt%5C%28%5Cs*%27database-health-check%27%2C%2F): Comprehensive database health assessment and recommendations - [`index-recommendation`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.prompt%5C%28%5Cs*%27index-recommendation%27%2C%2F): Get personalized index suggestions based on query patterns - [`migration-guide`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.prompt%5C%28%5Cs*%27migration-guide%27%2C%2F): Step-by-step MongoDB version migration plans - [`mongo-shell`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.prompt%5C%28%5Cs*%27mongo-shell%27%2C%2F): Generate MongoDB shell commands with explanations - [`multi-tenant-design`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.prompt%5C%28%5Cs*%27multi-tenant-design%27%2C%2F): Design MongoDB multi-tenant database architecture - [`query-builder`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.prompt%5C%28%5Cs*%27query-builder%27%2C%2F): Interactive guidance for constructing MongoDB queries - [`query-optimizer`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.prompt%5C%28%5Cs*%27query-optimizer%27%2C%2F): Optimization recommendations for slow queries - [`schema-analysis`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.prompt%5C%28%5Cs*%27schema-analysis%27%2C%2F): Detailed collection schema analysis with recommendations - [`schema-versioning`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.prompt%5C%28%5Cs*%27schema-versioning%27%2C%2F): Manage schema evolution in MongoDB applications - [`security-audit`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.prompt%5C%28%5Cs*%27security-audit%27%2C%2F): Database security analysis and improvement recommendations - [`sql-to-mongodb`](https://github.com/search?type=code&q=repo%3Afurey%2Fmongodb-lens+%2Fserver%5C.prompt%5C%28%5Cs*%27sql-to-mongodb%27%2C%2F): Convert SQL queries to MongoDB aggregation pipelines ### Other Features - [Overview](#other-features-overview) - [New Database Metadata](#other-features-new-database-metadata) #### Other Features: Overview MongoDB Lens includes numerous other features: - **[Config File](#configuration-config-file)**: Custom configuration via `~/.mongodb-lens.[jsonc|json]` - **[Env Var Overrides](#configuration-environment-variable-overrides)**: Override config settings via `process.env.CONFIG_*` - **[Confirmation System](#data-protection-confirmation-for-destructive-operations)**: Two-step verification for destructive operations - **[Multiple Connections](#configuration-multiple-mongodb-connections)**: Define and switch between named URI aliases - **[Component Disabling](#disabling-tools)**: Selectively disable tools, prompts or resources - **Connection Resilience**: Auto-reconnection with exponential backoff - **Query Safeguards**: Configurable limits and performance protections - **Error Handling**: Comprehensive JSONRPC error codes and messages - **Schema Inference**: Efficient schema analysis with intelligent sampling - **Credential Protection**: Connection string password obfuscation in logs - **Memory Management**: Auto-monitoring and cleanup for large operations - **Smart Caching**: Optimized caching for schema, indexes, fields and collections - **Backwards Compatible**: Support both modern and legacy MongoDB versions #### Other Features: New Database Metadata MongoDB Lens inserts a `metadata` collection into each database it creates. This `metadata` collection stores a single document containing contextual information serving as a permanent record of the database's origin while ensuring the new and otherwise empty database persists in MongoDB's storage system. <details> <summary><strong>Example metadata document</strong></summary> ```js { "_id" : ObjectId("67d5284463788ec38aecee14"), "created" : { "timestamp" : ISODate("2025-03-15T07:12:04.705Z"), "tool" : "MongoDB Lens v5.0.7", "user" : "anonymous" }, "mongodb" : { "version" : "3.6.23", "connectionInfo" : { "host" : "unknown", "readPreference" : "primary" } }, "database" : { "name" : "example_database", "description" : "Created via MongoDB Lens" }, "system" : { "hostname" : "unknown", "platform" : "darwin", "nodeVersion" : "v22.14.0" }, "lens" : { "version" : "5.0.7", "startTimestamp" : ISODate("2025-03-15T07:10:06.084Z") } } ``` </details> Once you've added your own collections to your new database, you can safely remove the `metadata` collection via the `drop-collection` tool: - _"Drop the new database's metadata collection"_<br> ^{➥ Uses `drop-collection` tool (with confirmation)} ## Installation MongoDB Lens can be installed and run in several ways: - [NPX](#installation-npx) (Easiest) - [Docker Hub](#installation-docker-hub) - [Node.js from Source](#installation-nodejs-from-source) - [Docker from Source](#installation-docker-from-source) - [Installation Verification](#installation-verification) - [Older MongoDB Versions](#installation-older-mongodb-versions) ### Installation: NPX > [!NOTE]<br> > NPX requires [Node.js](https://nodejs.org/en/download) installed and running on your system (suggestion: use [Volta](https://volta.sh)). The easiest way to run MongoDB Lens is using NPX. First, ensure Node.js is installed: ```console node --version # Ideally >= v22.x but MongoDB Lens is >= v18.x compatible ``` Then, run MongoDB Lens via NPX: ```console # Using default connection string mongodb://localhost:27017 npx -y mongodb-lens # Using custom connection string npx -y mongodb-lens mongodb://your-connection-string # Using "@latest" to keep the package up-to-date npx -y mongodb-lens@latest ``` > [!TIP]<br> > If you encounter permissions errors with `npx` try running `npx clear-npx-cache` prior to running `npx -y mongodb-lens` (this clears the cache and re-downloads the package). ### Installation: Docker Hub > [!NOTE]<br> > Docker Hub requires [Docker](https://docs.docker.com/get-started/get-docker) installed and running on your system. First, ensure Docker is installed: ```console docker --version # Ideally >= v27.x ``` Then, run MongoDB Lens via Docker Hub: ```console # Using default connection string mongodb://localhost:27017 docker run --rm -i --network=host furey/mongodb-lens # Using custom connection string docker run --rm -i --network=host furey/mongodb-lens mongodb://your-connection-string # Using "--pull" to keep the Docker image up-to-date docker run --rm -i --network=host --pull=always furey/mongodb-lens ``` ### Installation: Node.js from Source > [!NOTE]<br> > Node.js from source requires [Node.js](https://nodejs.org/en/download) installed and running on your system (suggestion: use [Volta](https://volta.sh)). 1. Clone the MongoDB Lens repository:<br> ```console git clone https://github.com/furey/mongodb-lens.git ``` 1. Navigate to the cloned repository directory:<br> ```console cd /path/to/mongodb-lens ``` 1. Ensure Node.js is installed:<br> ```console node --version # Ideally >= v22.x but MongoDB Lens is >= v18.x compatible ``` 1. Install Node.js dependencies:<br> ```console npm ci ``` 1. Start the server:<br> ```console # Using default connection string mongodb://localhost:27017 node mongodb-lens.js # Using custom connection string node mongodb-lens.js mongodb://your-connection-string ``` ### Installation: Docker from Source > [!NOTE]<br> > Docker from source requires [Docker](https://docs.docker.com/get-started/get-docker) installed and running on your system. 1. Clone the MongoDB Lens repository:<br> ```console git clone https://github.com/furey/mongodb-lens.git ``` 1. Navigate to the cloned repository directory:<br> ```console cd /path/to/mongodb-lens ``` 1. Ensure Docker is installed:<br> ```console docker --version # Ideally >= v27.x ``` 1. Build the Docker image:<br> ```console docker build -t mongodb-lens . ``` 1. Run the container:<br> ```console # Using default connection string mongodb://localhost:27017 docker run --rm -i --network=host mongodb-lens # Using custom connection string docker run --rm -i --network=host mongodb-lens mongodb://your-connection-string ``` ### Installation Verification To verify the installation, paste and run the following JSONRPC message into the server's stdio: ```json {"method":"resources/read","params":{"uri":"mongodb://databases"},"jsonrpc":"2.0","id":1} ``` The server should respond with a list of databases in your MongoDB instance, for example: ```json {"result":{"contents":[{"uri":"mongodb://databases","text":"Databases (12):\n- admin (180.00 KB)\n- config (108.00 KB)\n- local (40.00 KB)\n- sample_airbnb (51.88 MB)\n- sample_analytics (9.46 MB)\n- sample_geospatial (980.00 KB)\n- sample_guides (40.00 KB)\n- sample_mflix (108.90 MB)\n- sample_restaurants (7.73 MB)\n- sample_supplies (968.00 KB)\n- sample_training (40.85 MB)\n- sample_weatherdata (2.69 MB)"}]},"jsonrpc":"2.0","id":1} ``` MongoDB Lens is now installed and ready to accept MCP requests. ### Installation: Older MongoDB Versions If connecting to a MongoDB instance with a version `< 4.0`, the MongoDB Node.js driver used by the latest version of MongoDB Lens will not be compatible. Specifically, MongoDB Node.js driver versions `4.0.0` and above require MongoDB version `4.0` or higher. To use MongoDB Lens with older MongoDB instances, you need to use a MongoDB Node.js driver version from the `3.x` series (e.g. `3.7.4` which is compatible with MongoDB `3.6`). #### Older MongoDB Versions: Running from Source 1. Clone the MongoDB Lens repository:<br> ```console git clone https://github.com/furey/mongodb-lens.git ``` 1. Navigate to the cloned repository directory:<br> ```console cd /path/to/mongodb-lens ``` 1. Modify `package.json`:<br> ```diff "dependencies": { ... - "mongodb": "^6.15.0", // Or whatever newer version is listed + "mongodb": "^3.7.4", // Or whatever 3.x version is compatible with your older MongoDB instance ... } ``` 1. Install Node.js dependencies:<br> ```console npm install ``` 1. Start MongoDB Lens:<br> ```console node mongodb-lens.js mongodb://older-mongodb-instance ``` This will use the older driver version compatible with your MongoDB instance. > [!NOTE]<br> > You may also need to revert [this commit](https://github.com/furey/mongodb-lens/commit/603b28cbde72fcd62a15cd324afc93028380a054) to add back `useNewUrlParser` and `useUnifiedTopology` MongoDB configuration options. #### Older MongoDB Versions: Using NPX or Docker If you prefer to use NPX or Docker, you'll need to use an older version of MongoDB Lens that was published with a compatible driver. For example, MongoDB Lens `8.3.0` uses MongoDB Node.js driver `3.7.4` (see: [`package-lock.json`](https://github.com/furey/mongodb-lens/blob/8.3.0/package-lock.json#L944-L945)). To run an older version of MongoDB Lens using NPX, specify the version tag: ```console npx -y mongodb-lens@8.3.0 ``` Similarly for Docker: ```console docker run --rm -i --network=host furey/mongodb-lens:8.3.0 ``` ## Configuration - [MongoDB Connection String](#configuration-mongodb-connection-string) - [Config File](#configuration-config-file) - [Config File Generation](#configuration-config-file-generation) - [Multiple MongoDB Connections](#configuration-multiple-mongodb-connections) - [Environment Variable Overrides](#configuration-environment-variable-overrides) - [Cross-Platform Environment Variables](#configuration-cross-platform-environment-variables) ### Configuration: MongoDB Connection String The server accepts a MongoDB connection string as its only argument. Example NPX usage: ```console npx -y mongodb-lens@latest mongodb://your-connection-string ``` MongoDB connection strings have the following format: ```txt mongodb://[username:password@]host[:port][/database][?options] ``` Example connection strings: - Local connection:<br> `mongodb://localhost:27017` - Connection to `mydatabase` with credentials from `admin` database:<br> `mongodb://username:password@hostname:27017/mydatabase?authSource=admin` - Connection to `mydatabase` with various other options:<br> `mongodb://hostname:27017/mydatabase?retryWrites=true&w=majority` If no connection string is provided, the server will attempt to connect via local connection. ### Configuration: Config File MongoDB Lens supports extensive customization via JSON configuration file. > [!NOTE]<br> > The config file is optional. MongoDB Lens will run with default settings if no config file is provided. > [!TIP]<br> > You only need to include the settings you want to customize in the config file. MongoDB Lens will use default settings for any omitted values. > [!TIP]<br> > MongoDB Lens supports both `.json` and `.jsonc` (JSON with comments) config file formats. <details> <summary><strong>Example configuration file</strong></summary> ```jsonc { "mongoUri": "mongodb://localhost:27017", // Default MongoDB connection string or object of alias-URI pairs "connectionOptions": { "maxPoolSize": 20, // Maximum number of connections in the pool "retryWrites": false, // Whether to retry write operations "connectTimeoutMS": 30000, // Connection timeout in milliseconds "socketTimeoutMS": 360000, // Socket timeout in milliseconds "heartbeatFrequencyMS": 10000, // How often to ping servers for status "serverSelectionTimeoutMS": 30000 // Timeout for server selection }, "defaultDbName": "admin", // Default database if not specified in URI "connection": { "maxRetries": 5, // Maximum number of initial connection attempts "maxRetryDelayMs": 30000, // Maximum delay between retries "reconnectionRetries": 10, // Maximum reconnection attempts if connection lost "initialRetryDelayMs": 1000 // Initial delay between retries }, "disabled": { "tools": [], // List of tools to disable or true to disable all "prompts": [], // List of prompts to disable or true to disable all "resources": [] // List of resources to disable or true to disable all }, "cacheTTL": { "stats": 15000, // Stats cache lifetime in milliseconds "fields": 30000, // Fields cache lifetime in milliseconds "schemas": 60000, // Schema cache lifetime in milliseconds "indexes": 120000, // Index cache lifetime in milliseconds "collections": 30000, // Collections list cache lifetime in milliseconds "serverStatus": 20000 // Server status cache lifetime in milliseconds }, "enabledCaches": [ // List of caches to enable "stats", // Statistics cache "fields", // Collection fields cache "schemas", // Collection schemas cache "indexes", // Collection indexes cache "collections", // Database collections cache "serverStatus" // MongoDB server status cache ], "memory": { "enableGC": true, // Whether to enable garbage collection "warningThresholdMB": 1500, // Memory threshold for warnings "criticalThresholdMB": 2000 // Memory threshold for cache clearing }, "logLevel": "info", // Log level (info or verbose) "disableDestructiveOperationTokens": false, // Whether to skip confirmation for destructive ops "watchdogIntervalMs": 30000, // Interval for connection monitoring "defaults": { "slowMs": 100, // Threshold for slow query detection "queryLimit": 10, // Default limit for query results "allowDiskUse": true, // Allow operations to use disk for large datasets "schemaSampleSize": 100, // Sample size for schema inference "aggregationBatchSize": 50 // Batch size for aggregation operations }, "security": { "tokenLength": 4, // Length of confirmation tokens "tokenExpirationMinutes": 5, // Expiration time for tokens "strictDatabaseNameValidation": true // Enforce strict database name validation }, "tools": { "transaction": { "readConcern": "snapshot", // Read concern level for transactions "writeConcern": { "w": "majority" // Write concern for transactions } }, "bulkOperations": { "ordered": true // Whether bulk operations execute in order }, "export": { "defaultLimit": -1, // Default limit for exports (-1 = no limit) "defaultFormat": "json" // Default export format (json or csv) }, "watchChanges": { "maxDurationSeconds": 60, // Maximum duration for change streams "defaultDurationSeconds": 10 // Default duration for change streams }, "queryAnalysis": { "defaultDurationSeconds": 10 // Default duration for query analysis } } } ``` </details> By default, MongoDB Lens looks for the config file at: - `~/.mongodb-lens.jsonc` first, then falls back to - `~/.mongodb-lens.json` if the former doesn't exist To customize the config file path, set the environment variable `CONFIG_PATH` to the desired file path. Example NPX usage: ```console CONFIG_PATH='/path/to/config.json' npx -y mongodb-lens@latest ``` Example Docker Hub usage: ```console docker run --rm -i --network=host --pull=always -v /path/to/config.json:/root/.mongodb-lens.json furey/mongodb-lens ``` ### Configuration: Config File Generation You can generate a configuration file automatically using the `config:create` script: ```console # NPX Usage (recommended) npx -y mongodb-lens@latest config:create # Node.js Usage npm run config:create # Force overwrite existing files npx -y mongodb-lens@latest config:create -- --force npm run config:create -- --force ``` This script extracts the [example configuration file](#configuration-config-file) above and saves it to: `~/.mongodb-lens.jsonc` #### Config File Generation: Custom Path You can specify a custom output location using the `CONFIG_PATH` environment variable. - If `CONFIG_PATH` has no file extension, it's treated as a directory and `.mongodb-lens.jsonc` is appended - If `CONFIG_PATH` ends with `.json` (not `.jsonc`) comments are removed from the generated file Example NPX usage: ```console # With custom path CONFIG_PATH=/path/to/config.jsonc npx -y mongodb-lens@latest config:create # Save to directory (will append .mongodb-lens.jsonc to the path) CONFIG_PATH=/path/to/directory npx -y mongodb-lens@latest config:create # Save as JSON instead of JSONC CONFIG_PATH=/path/to/config.json npx -y mongodb-lens@latest config:create ``` Example Node.js usage: ```console # With custom path CONFIG_PATH=/path/to/config.jsonc node mongodb-lens.js config:create # Save to directory (will append .mongodb-lens.jsonc to the path) CONFIG_PATH=/path/to/directory node mongodb-lens.js config:create # Save as JSON instead of JSONC CONFIG_PATH=/path/to/config.json node mongodb-lens.js config:create ``` ### Configuration: Multiple MongoDB Connections MongoDB Lens supports multiple MongoDB URIs with aliases in your [config file](#configuration-config-file), allowing you to easily switch between different MongoDB instances using simple names. To configure multiple connections, set the `mongoUri` config setting to an object with alias-URI pairs: ```json { "mongoUri": { "main": "mongodb://localhost:27017", "backup": "mongodb://localhost:27018", "atlas": "mongodb+srv://username:password@cluster.mongodb.net/mydb" } } ``` With this configuration: - The first URI in the list (e.g. `main`) becomes the default connection at startup - You can switch connections using natural language: `"Connect to backup"` or `"Connect to atlas"` - The original syntax still works: `"Connect to mongodb://localhost:27018"` - The `list-connections` tool shows all available connection aliases > [!NOTE]<br> > When using the command-line argument to specify a connection, you can use either a full MongoDB URI or an alias defined in your configuration file. > [!TIP]<br> > To add connection aliases at runtime, use the `add-connection-alias` tool. ### Configuration: Environment Variable Overrides MongoDB Lens supports environment variable overrides for configuration settings. Environment variables take precedence over [config file](#configuration-config-file) settings. Config environment variables follow the naming pattern: ```txt CONFIG_[SETTING PATH, SNAKE CASED, UPPERCASED] ``` Example overrides: | Config Setting | Environment Variable Override | | -------------------------------- | ----------------------------------------- | | `mongoUri` | `CONFIG_MONGO_URI` | | `logLevel` | `CONFIG_LOG_LEVEL` | | `defaultDbName` | `CONFIG_DEFAULT_DB_NAME` | | `defaults.queryLimit` | `CONFIG_DEFAULTS_QUERY_LIMIT` | | `tools.export.defaultFormat` | `CONFIG_TOOLS_EXPORT_DEFAULT_FORMAT` | | `connectionOptions.maxPoolSize` | `CONFIG_CONNECTION_OPTIONS_MAX_POOL_SIZE` | | `connection.reconnectionRetries` | `CONFIG_CONNECTION_RECONNECTION_RETRIES` | For environment variable values: - For boolean settings, use string values `'true'` or `'false'`. - For numeric settings, use string representations. - For nested objects or arrays, use JSON strings. Example NPX usage: ```console CONFIG_DEFAULTS_QUERY_LIMIT='25' npx -y mongodb-lens@latest ``` Example Docker Hub usage: ```console docker run --rm -i --network=host --pull=always -e CONFIG_DEFAULTS_QUERY_LIMIT='25' furey/mongodb-lens ``` ### Configuration: Cross-Platform Environment Variables For consistent environment variable usage across Windows, macOS, and Linux, consider using `cross-env`: 1. Install cross-env globally:<br> ```console # Using NPM npm install -g cross-env # Using Volta (see: https://volta.sh) volta install cross-env ``` 1. Prefix any NPX or Node.js environment variables in this document's examples:<br> ```console # Example NPX usage with cross-env cross-env CONFIG_DEFAULTS_QUERY_LIMIT='25' npx -y mongodb-lens@latest # Example Node.js usage with cross-env cross-env CONFIG_DEFAULTS_QUERY_LIMIT='25' node mongodb-lens.js ``` ## Client Setup - [Claude Desktop](#client-setup-claude-desktop) - [MCP Inspector](#client-setup-mcp-inspector) - [Other MCP Clients](#client-setup-other-mcp-clients) ### Client Setup: Claude Desktop To use MongoDB Lens with Claude Desktop: 1. Install [Claude Desktop](https://claude.ai/download) 1. Open `claude_desktop_config.json` (create if it doesn't exist): - macOS: `~/Library/Application Support/Claude/claude_desktop_config.json` - Windows: `%APPDATA%\Claude\claude_desktop_config.json` 1. Add the MongoDB Lens server configuration as per [configuration options](#claude-desktop-configuration-options) 1. Restart Claude Desktop 1. Start a conversation with Claude about your MongoDB data #### Claude Desktop Configuration Options - [Option 1: NPX (Recommended)](#option-1-npx-recommended) - [Option 2: Docker Hub Image](#option-2-docker-hub-image) - [Option 3: Local Node.js Installation](#option-3-local-nodejs-installation) - [Option 4: Local Docker Image](#option-4-local-docker-image) For each option: - Replace `mongodb://your-connection-string` with your MongoDB connection string or omit it to use the default `mongodb://localhost:27017`. - To use a custom config file, set [`CONFIG_PATH`](#configuration-config-file) environment variable. - To include environment variables: - For NPX or Node.js add `"env": {}` with key-value pairs, for example:<br> ```json "command": "/path/to/npx", "args": [ "-y", "mongodb-lens@latest", "mongodb://your-connection-string" ], "env": { "CONFIG_LOG_LEVEL": "verbose" } ``` - For Docker add `-e` flags, for example:<br> ```json "command": "docker", "args": [ "run", "--rm", "-i", "--network=host", "--pull=always", "-e", "CONFIG_LOG_LEVEL='verbose'", "furey/mongodb-lens", "mongodb://your-connection-string" ] ``` ##### Option 1: NPX (Recommended) ```json { "mcpServers": { "mongodb-lens": { "command": "/path/to/npx", "args": [ "-y", "mongodb-lens@latest", "mongodb://your-connection-string" ] } } } ``` ##### Option 2: Docker Hub Image ```json { "mcpServers": { "mongodb-lens": { "command": "docker", "args": [ "run", "--rm", "-i", "--network=host", "--pull=always", "furey/mongodb-lens", "mongodb://your-connection-string" ] } } } ``` ##### Option 3: Local Node.js Installation ```json { "mcpServers": { "mongodb-lens": { "command": "/path/to/node", "args": [ "/path/to/mongodb-lens.js", "mongodb://your-connection-string" ] } } } ``` ##### Option 4: Local Docker Image ```json { "mcpServers": { "mongodb-lens": { "command": "docker", "args": [ "run", "--rm", "-i", "--network=host", "mongodb-lens", "mongodb://your-connection-string" ] } } } ``` ### Client Setup: MCP Inspector [MCP Inspector](https://github.com/modelcontextprotocol/inspector) is a tool designed for testing and debugging MCP servers. > [!NOTE]<br> > MCP Inspector starts a proxy server on port 3000 and web client on port 5173. Example NPX usage: 1. Run MCP Inspector:<br> ```console # Using default connection string mongodb://localhost:27017 npx -y @modelcontextprotocol/inspector npx -y mongodb-lens@latest # Using custom connection string npx -y @modelcontextprotocol/inspector npx -y mongodb-lens@latest mongodb://your-connection-string # Using custom ports SERVER_PORT=1234 CLIENT_PORT=5678 npx -y @modelcontextprotocol/inspector npx -y mongodb-lens@latest ``` 1. Open MCP Inspector: http://localhost:5173 MCP Inspector should support the full range of MongoDB Lens capabilities, including autocompletion for collection names and query fields. For more, see: [MCP Inspector](https://modelcontextprotocol.io/docs/tools/inspector) ### Client Setup: Other MCP Clients MongoDB Lens should be usable with any MCP-compatible client. For more, see: [MCP Documentation: Example Clients](https://modelcontextprotocol.io/clients) ## Data Protection To protect your data while using MongoDB Lens, consider the following: - [Read-Only User Accounts](#data-protection-read-only-user-accounts) - [Working with Database Backups](#data-protection-working-with-database-backups) - [Confirmation for Destructive Operations](#data-protection-confirmation-for-destructive-operations) - [Disabling Destructive Operations](#data-protection-disabling-destructive-operations) ### Data Protection: Read-Only User Accounts When connecting MongoDB Lens to your database, the permissions granted to the user in the MongoDB connection string dictate what actions can be performed. When the use case fits, a read-only user can prevent unintended writes or deletes, ensuring MongoDB Lens can query data but not alter it. To set this up, create a user with the `read` role scoped to the database(s) you're targeting. In MongoDB shell, you'd run something like: ```js use admin db.createUser({ user: 'readonly', pwd: 'eXaMpLePaSsWoRd', roles: [{ role: 'read', db: 'mydatabase' }] }) ``` Then, apply those credentials to your MongoDB connection string: ```txt mongodb://readonly:eXaMpLePaSsWoRd@localhost:27017/mydatabase ``` Using read-only credentials is a simple yet effective way to enforce security boundaries, especially when you're poking around schemas or running ad-hoc queries. ### Data Protection: Working with Database Backups When working with MongoDB Lens, consider connecting to a backup copy of your data hosted on a separate MongoDB instance. Start by generating the backup with `mongodump`. Next, spin up a fresh MongoDB instance (e.g. on a different port like `27018`) and restore the backup there using `mongorestore`. Once it's running, point MongoDB Lens to the backup instance's connection string (e.g. `mongodb://localhost:27018/mydatabase`). This approach gives you a sandbox to test complex or destructive operations against without risking accidental corruption of your live data. ### Data Protection: Confirmation for Destructive Operations MongoDB Lens implements a token-based confirmation system for potentially destructive operations, requiring a two-step process to execute tools that may otherwise result in unchecked data loss: 1. First tool invocation: Returns a 4-digit confirmation token that expires after 5 minutes 1. Second tool invocation: Executes the operation if provided with the valid token For an example of the confirmation process, see: [Working with Confirmation Protection](#tutorial-5-working-with-confirmation-protection) Tools that require confirmation include: - `drop-user`: Remove a database user - `drop-index`: Remove an index (potential performance impact) - `drop-database`: Permanently delete a database - `drop-collection`: Delete a collection and all its documents - `delete-document`: Delete one or multiple documents - `bulk-operations`: When including delete operations - `rename-collection`: When the target collection exists and will be dropped This protection mechanism aims to prevent accidental data loss from typos and unintended commands. It's a safety net ensuring you're aware of the consequences before proceeding with potentially harmful actions. > [!NOTE]<br> > If you're working in a controlled environment where data loss is acceptable, you can configure MongoDB Lens to [bypass confirmation](#bypassing-confirmation-for-destructive-operations) and perform destructive operations immediately. #### Bypassing Confirmation for Destructive Operations You might want to bypass the token confirmation system. Set the environment variable `CONFIG_DISABLE_DESTRUCTIVE_OPERATION_TOKENS` to `true` to execute destructive operations immediately without confirmation: ```console # Using NPX CONFIG_DISABLE_DESTRUCTIVE_OPERATION_TOKENS=true npx -y mongodb-lens@latest # Using Docker docker run --rm -i --network=host --pull=always -e CONFIG_DISABLE_DESTRUCTIVE_OPERATION_TOKENS='true' furey/mongodb-lens ``` > [!WARNING]<br> > Disabling confirmation tokens removes an important safety mechanism. It's strongly recommended to only use this option in controlled environments where data loss is acceptable, such as development or testing. Disable at your own risk. ### Data Protection: Disabling Destructive Operations - [Disabling Tools](#disabling-tools) - [High-Risk Tools](#high-risk-tools) - [Medium-Risk Tools](#medium-risk-tools) - [Read-Only Configuration](#read-only-configuration) #### Disabling Tools MongoDB Lens includes several tools that can modify or delete data. To disable specific tools, add them to the `disabled.tools` array in your [configuration file](#configuration-config-file): ```json { "disabled": { "tools": [ "drop-user", "drop-index", "drop-database", "drop-collection", "delete-document", "bulk-operations", "rename-collection" ] } } ``` #### High-Risk Tools These tools can cause immediate data loss and should be considered for disabling in sensitive environments: - `drop-user`: Removes database users and their access permissions - `drop-index`: Removes indexes (can impact query performance) - `drop-database`: Permanently deletes entire databases - `drop-collection`: Permanently deletes collections and all their documents - `delete-document`: Removes documents matching specified criteria - `bulk-operations`: Can perform batch deletions when configured to do so - `rename-collection`: Can overwrite existing collections when using the drop target option #### Medium-Risk Tools These tools can modify data but typically don't cause immediate data loss: - `create-user`: Creates users with permissions that could enable further changes - `transaction`: Executes multiple operations in a transaction (potential for complex changes) - `update-document`: Updates documents which could overwrite existing data #### Read-Only Configuration For a complete read-only configuration, disable all potentially destructive tools: ```json { "disabled": { "tools": [ "drop-user", "drop-index", "create-user", "transaction", "create-index", "drop-database", "drop-collection", "insert-document", "update-document", "delete-document", "bulk-operations", "create-database", "gridfs-operation", "create-collection", "rename-collection", "create-timeseries" ] } } ``` This configuration allows MongoDB Lens to query and analyze data while preventing any modifications, providing multiple layers of protection against accidental data loss. ## Tutorial This following tutorial guides you through setting up a MongoDB container with sample data, then using MongoDB Lens to interact with it through natural language queries: 1. [Start Sample Data Container](#tutorial-1-start-sample-data-container) 1. [Import Sample Data](#tutorial-2-import-sample-data) 1. [Connect MongoDB Lens](#tutorial-3-connect-mongodb-lens) 1. [Example Queries](#tutorial-4-example-queries) 1. [Working With Confirmation Protection](#tutorial-5-working-with-confirmation-protection) ### Tutorial: 1. Start Sample Data Container > [!NOTE]<br> > This tutorial assumes you have [Docker](https://docs.docker.com/get-started/get-docker/) installed and running on your system. > [!IMPORTANT]<br> > If Docker is already running a container on port 27017, stop it before proceeding. 1. Initialise the sample data container:<br> ```console docker run --name mongodb-sampledata -d -p 27017:27017 mongo:6 ``` 1. Verify the container is running without issue:<br> ```console docker ps | grep mongodb-sampledata ``` ### Tutorial: 2. Import Sample Data MongoDB provides several [sample datasets](https://www.mongodb.com/docs/atlas/sample-data/#available-sample-datasets) which we'll use to explore MongoDB Lens. 1. Download the sample datasets: ```console<br> curl -LO https://atlas-education.s3.amazonaws.com/sampledata.archive ``` 1. Copy the sample datasets into your sample data container:<br> ```console docker cp sampledata.archive mongodb-sampledata:/tmp/ ``` 1. Import the sample datasets into MongoDB:<br> ```console docker exec -it mongodb-sampledata mongorestore --archive=/tmp/sampledata.archive ``` This will import several databases: - `sample_airbnb`: Airbnb listings and reviews - `sample_analytics`: Customer and account data - `sample_geospatial`: Geographic data - `sample_mflix`: Movie data - `sample_restaurants`: Restaurant data - `sample_supplies`: Supply chain data - `sample_training`: Training data for various applications - `sample_weatherdata`: Weather measurements ### Tutorial: 3. Connect MongoDB Lens [Install](#installation) MongoDB Lens as per the [Quick Start](#quick-start) instructions. Set your [MCP Client](#client-setup) to connect to MongoDB Lens via: `mongodb://localhost:27017` > [!TIP]<br> > Omitting the connection string from your MCP Client configuration will default the connection string to `mongodb://localhost:27017`. Example [Claude Desktop configuration](#client-setup-claude-desktop): ```json { "mcpServers": { "mongodb-lens": { "command": "/path/to/npx", "args": [ "-y", "mongodb-lens@latest" ] } } } ``` ### Tutorial: 4. Example Queries With your MCP Client running and connected to MongoDB Lens, try the following example queries: - [Example Queries: Basic Database Operations](#example-queries-basic-database-operations) - [Example Queries: Collection Management](#example-queries-collection-management) - [Example Queries: User Management](#example-queries-user-management) - [Example Queries: Querying Data](#example-queries-querying-data) - [Example Queries: Schema Analysis](#example-queries-schema-analysis) - [Example Queries: Data Modification](#example-queries-data-modification) - [Example Queries: Performance & Index Management](#example-queries-performance--index-management) - [Example Queries: Geospatial & Special Operations](#example-queries-geospatial--special-operations) - [Example Queries: Export, Administrative & Other Features](#example-queries-export-administrative--other-features) - [Example Queries: Connection Management](#example-queries-connection-management) #### Example Queries: Basic Database Operations - _"List all databases"_<br> ^{➥ Uses `list-databases` tool} - _"What db am I currently using?"_<br> ^{➥ Uses `current-database` tool} - _"Switch to the sample_mflix database"_<br> ^{➥ Uses `use-database` tool} - _"Create a new db called test_db"_<br> ^{➥ Uses `create-database` tool} - _"Create another db called analytics_db and switch to it"_<br> ^{➥ Uses `create-database` tool with switch=true} - _"Drop test_db"_<br> ^{➥ Uses `drop-database` tool (with confirmation)} #### Example Queries: Collection Management - _"What collections are in the current database?"_<br> ^{➥ Uses `list-collections` tool} - _"Create user_logs collection"_<br> ^{➥ Uses `create-collection` tool} - _"Rename user_logs to system_logs"_<br> ^{➥ Uses `rename-collection` tool} - _"Drop system_logs"_<br> ^{➥ Uses `drop-collection` tool (with confirmation)} - _"Check the data consistency in the movies collection"_<br> ^{➥ Uses `validate-collection` tool} #### Example Queries: User Management - _"Create a read-only user for analytics"_<br> ^{➥ Uses `create-user` tool} - _"Drop the inactive_user account"_<br> ^{➥ Uses `drop-user` tool (with confirmation)} #### Example Queries: Querying Data - _"Count all docs in the movies collection"_<br> ^{➥ Uses `count-documents` tool} - _"Find the top 5 movies with the highest IMDB rating"_<br> ^{➥ Uses `find-documents` tool} - _"Show me aggregate data for movies grouped by decade"_<br> ^{➥ Uses `aggregate-data` tool} - _"List all unique countries where movies were produced"_<br> ^{➥ Uses `distinct-values` tool} - _"Search for movies containing godfather in their title"_<br> ^{➥ Uses `text-search` tool} - _"Find German users with last name müller using proper collation"_<br> ^{➥ Uses `collation-query` tool} #### Example Queries: Schema Analysis - _"What's the schema structure of the movies collection?"_<br> ^{➥ Uses `analyze-schema` tool} - _"Compare users and comments schemas"_<br> ^{➥ Uses `compare-schemas` tool} - _"Generate a schema validator for the movies collection"_<br> ^{➥ Uses `generate-schema-validator` tool} - _"Analyze common query patterns for the movies collection"_<br> ^{➥ Uses `analyze-query-patterns` tool} #### Example Queries: Data Modification - _"Insert new movie document: \<your field data\>"_<br> ^{➥ Uses `insert-document` tool} - _"Update all movies from 1994 to add a 'classic' flag"_<br> ^{➥ Uses `update-document` tool} - _"Delete all movies with zero ratings"_<br> ^{➥ Uses `delete-document` tool (with confirmation)} - _"Run these bulk operations on the movies collection: \<your JSON data\>"_<br> ^{➥ Uses `bulk-operations` tool} > [!TIP]<br> > For specialized MongoDB operations (like array operations, bitwise operations, or other complex updates), use MongoDB's native operators via the `update-document` tool's `update` and `options` parameters. #### Example Queries: Performance & Index Management - _"Create an index on the title field in the movies collection"_<br> ^{➥ Uses `create-index` tool} - _"Drop the ratings_idx index"_<br> ^{➥ Uses `drop-index` tool (with confirmation)} - _"Explain the execution plan for finding movies from 1995"_<br> ^{➥ Uses `explain-query` tool} - _"Get statistics for the current db"_<br> ^{➥ Uses `get-stats` tool with target=database} - _"Show collection stats for the movies collection"_<br> ^{➥ Uses `get-stats` tool with target=collection} #### Example Queries: Geospatial & Special Operations - _"Switch to sample_geospatial db, then find all shipwrecks within 10km of coordinates [-80.12, 26.46]"_<br> ^{➥ Uses `geo-query` tool} - _"Switch to sample_analytics db, then execute a transaction to move funds between accounts: \<account ids\>"_<br> ^{➥ Uses `transaction` tool} - _"Create a time series collection for sensor readings"_<br> ^{➥ Uses `create-timeseries` tool} - _"Watch for changes in the users collection for 30 seconds"_<br> ^{➥ Uses `watch-changes` tool} - _"List all files in the images GridFS bucket"_<br> ^{➥ Uses `gridfs-operation` tool with operation=list} #### Example Queries: Export, Administrative & Other Features - _"Switch to sample_mflix db, then export the top 20 movies based on 'tomatoes.critic.rating' as a CSV with title, year and rating fields (output in a single code block)"_<br> ^{➥ Uses `export-data` tool} - _"Switch to sample_analytics db, then check its sharding status"_<br> ^{➥ Uses `shard-status` tool} - _"Clear the collections cache"_<br> ^{➥ Uses `clear-cache` tool with target=collections} - _"Clear all caches"_<br> ^{➥ Uses `clear-cache` tool} - _"Switch to sample_weatherdata db then generate an interactive report on its current state"_<br> ^{➥ Uses numerous tools} #### Example Queries: Connection Management - _"Connect to mongodb://localhost:27018"_<br> ^{➥ Uses `connect-mongodb` tool} - _"Connect to mongodb+srv://username:password@cluster.mongodb.net/mydb"_<br> ^{➥ Uses `connect-mongodb` tool} - _"Connect back to the original mongodb instance"_<br> ^{➥ Uses `connect-original` tool} - _"Connect to replica set without validating the connection: \<replica set details\>"_<br> ^{➥ Uses `connect-mongodb` tool with validateConnection=false} - _"Add connection alias 'prod' for mongodb://username:password@prod-server:27017/mydb"_<br> ^{➥ Uses `add-connection-alias` tool} ### Tutorial: 5. Working With Confirmation Protection MongoDB Lens includes a safety mechanism for potentially destructive operations. Here's how it works in practice: 1. Request to drop a collection:<br> ``` "Drop the collection named test_collection" ``` 1. MongoDB Lens responds with a warning and confirmation token:<br> ``` ⚠️ DESTRUCTIVE OPERATION WARNING ⚠️ You've requested to drop the collection 'test_collection'. This operation is irreversible and will permanently delete all data in this collection. To confirm, you must type the 4-digit confirmation code EXACTLY as shown below: Confirmation code: 9876 This code will expire in 5 minutes for security purposes. ``` 1. Confirm the operation by submitting the confirmation token:<br> ``` "9876" ``` 1. MongoDB Lens executes the operation:<br> ``` Collection 'test_collection' has been permanently deleted. ``` This two-step process prevents accidental data loss by requiring explicit confirmation. > [!NOTE]<br> > If you're working in a controlled environment where data loss is acceptable, you can configure MongoDB Lens to [bypass confirmation](#bypassing-confirmation-for-destructive-operations) and perform destructive operations immediately. ## Test Suite MongoDB Lens includes a [test suite](./mongodb-lens.test.js) to verify functionality across tools, resources, and prompts. - [Running Tests](#test-suite-running-tests) - [Command Line Options](#test-suite-command-line-options) - [Examples](#test-suite-examples) ### Test Suite: Running Tests The test suite requires a `CONFIG_MONGO_URI` environment variable which can be set to: - a MongoDB connection string (e.g. `mongodb://localhost:27017`) - `mongodb-memory-server` (for in-memory testing) ```console # Run Tests with MongoDB Connection String CONFIG_MONGO_URI=mongodb://localhost:27017 node mongodb-lens.test.js # Run Tests with In-Memory MongoDB (requires mongodb-memory-server) CONFIG_MONGO_URI=mongodb-memory-server node mongodb-lens.test.js ``` For convenience, the following scripts are available for running tests: ```console npm test # Fails if no CONFIG_MONGO_URI provided npm run test:localhost # Uses mongodb://localhost:27017 npm run test:localhost:verbose # Runs with DEBUG=true for verbose output npm run test:in-memory # Uses mongodb-memory-server npm run test:in-memory:verbose # Runs with DEBUG=true for verbose output ``` > [!NOTE]<br> > The test suite creates temporary databases and collections that are cleaned up after test completion. ### Test Suite: Command Line Options | Option | Description | | ------------------ | ---------------------------------------------------- | | `--list` | List all available tests without running them | | `--test=<n>` | Run specific test(s) by name (comma-separated) | | `--group=<n>` | Run all tests in specific group(s) (comma-separated) | | `--pattern=<glob>` | Run tests matching pattern(s) (comma-separated) | ### Test Suite: Examples ```console # List All Available Tests npm test -- --list # Run Only Connection-Related Tests (:27017) npm run test:localhost -- --group=Connection\ Tools # Test Specific Database Operations (In-Memory) npm run test:in-memory -- --test=create-database\ Tool,drop-database\ Tool # Test All Document-Related Tools (:27017) npm run test:localhost -- --pattern=document # Run Resource Tests Only (In-Memory) npm run test:in-memory -- --group=Resources # Run Specific Tests Only (In-Memory) npm run test:in-memory -- --test=aggregate-data\ Tool,find-documents\ Tool ``` ## Disclaimer MongoDB Lens: - is licensed under the [MIT License](./LICENSE). - is not affiliated with or endorsed by MongoDB, Inc. - is written with the assistance of AI and may contain errors. - is intended for educational and experimental purposes only. - is provided as-is with no warranty—please use at your own risk. ## Support If you've found MongoDB Lens helpful consider supporting my work through: [Buy Me a Coffee](https://www.buymeacoffee.com/furey) | [GitHub Sponsorship](https://github.com/sponsors/furey) Contributions help me continue developing and improving this tool, allowing me to dedicate more time to add new features and ensuring it remains a valuable resource for the community.