Mongodb Database

🚀 MCP Database Server

An implementation of the Model Context Protocol (MCP) server that allows Large Language Models (LLMs) to interact with various databases through natural language. Currently supports MongoDB, with plans to support the following in the future:

• PostgreSQL
• CockroachDB
• Redis
• etc...

🚀 Quick Start

The MCP Database Server enables seamless interaction between LLMs and databases via natural language. It currently supports MongoDB and is set to expand support to other databases soon.

✨ Features

• Perform database operations through natural language.
• Current features supported for MongoDB include:
  • List all collections.
  • Document queries with filtering and projection.
  • Insert documents.
  • Delete documents.
  • Aggregation pipeline operations.
• Future support for other databases:
  • PostgreSQL: Execute SQL queries and perform table operations.
  • CockroachDB: Conduct distributed SQL operations.
  • Redis: Perform key - value operations and caching.

📦 Installation

Prerequisites

• Node.js v20.12.2 or higher.
• A database (currently MongoDB, others coming soon).
• Claude Desktop application.

Steps

1. Clone the repository:

git clone https://github.com/manpreet2000/mcp-database-server.git
cd mcp-database-server

2. Install dependencies:

npm install

3. Build the TypeScript code:

npm run build

📚 Documentation

Configuration

To start using, configure the database connection in your Claude Desktop configuration file:

MacOS

~/Library/Application\ 支持/Claude/claude_desktop_config.json

Windows

%APPDATA%/Claude/claude_desktop_config.json

Add the following configuration to your claude_desktop_config.json file:

{
  "mcpServers": {
    "database": {
      "command": "/path/to/node",
      "args": ["/path/to/mcp-database/dist/index.js"],
      "env": {
        "MONGODB_URI": "your-mongodb-connection-string"
      }
    }
  }
}

Replace:

• /path/to/node with the path to your installed Node.js executable, or use node directly.
• /path/to/mcp-database with the absolute path of this repository.
• your-mongodb-connection-string with your MongoDB connection string.

💻 Usage Examples

MongoDB Examples

1. List all collections in the database:

Can you show me all the collections in the database?

2. Retrieve records from a specific collection:

Please give me two records from the chargers collection.

3. Query with filters:

Show all documents with the status 'active' in the users collection.

4. Insert a document:

Insert this { "name": "Alice", "age": 30 } into the users collection.

5. Delete a document:

Delete the document where the name is 'Bob' from the users collection.

Available Tools

• getCollections(): Returns all collections in the database.
• getCollection(collectionName): Returns a reference to the specified collection.
• find(query, projection): Performs a find operation based on the query and projection.
• insertOne(document): Inserts a single document into the collection.
• insertMany(documents): Inserts multiple documents into the collection.
• updateOne(query, update): Updates the first document that matches the query.
• updateMany(query, update): Updates all documents that match the query.
• replaceOne(query, replacement): Replaces the first document that matches the query.
• deleteOne(query): Deletes the first document that matches the query.
• deleteMany(query): Deletes all documents that match the query.

🔧 Technical Details

Future Database Support

• PostgreSQL: Execute SQL queries, perform table operations, and manage schemas.
• CockroachDB: Conduct distributed transactions and execute SQL operations.
• Redis: Perform key - value storage operations, and operate on lists, sets, hashes, and sorted sets.