Manpreet2000 MCP Database Server

🚀 MCP Database Server

An implementation of the Model Context Protocol (MCP) server that enables 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
• And more...

🚀 Quick Start

The MCP Database Server allows LLMs to interact with databases using natural language. It currently supports MongoDB and will support more databases in the future.

✨ Features

• Execute database operations via natural language.
• Current features supported for MongoDB include:
  • List all collections.
  • Query documents with filtering and projection.
  • Insert documents.
  • Delete documents.
  • Perform 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 pair 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

Before starting, you need to set up the database connection in the Claude Desktop configuration file:

MacOS

~/Library/Application\ Support/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 the following:

• /path/to/node: Replace with the path to your system's Node.js executable, or simply use node.
• /path/to/mcp-database: Replace with the absolute path of this repository.
• your-mongodb-connection-string: Replace with your MongoDB connection string.

💻 Usage Examples

MongoDB Examples

1. List all collections in the database:

Can you show me all the collections in my database?

2. Get records from a specific collection:

Please show me 2 records from the chargers collection.

3. Query with filtering conditions:

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

4. Insert a document:

Add a new user named John with the email john@example.com to the users collection.

5. Delete a document:

Delete the user with the email john@example.com from the users collection.

6. Aggregation operation:

Show me the total number of users grouped by status in the users collection.

🛠️ Available Tools

1. getCollections

List all collections in the database.

2. getCollection

Get a collection with the specified name.

Parameters:

• collectionName: The name of the collection to retrieve.

3. find

Execute a query operation and return a specified number of results.

Parameters:

• collectionName: The name of the collection to query.
• query (optional): Query conditions.
• limit (optional): Limit the number of returned results, default is 5.

4. findOne

Execute a single - document query.

Parameters:

• collectionName: The name of the collection to query.
• query: Query conditions.

5. insertOne

Insert a new document.

Parameters:

• collectionName: The collection where the document will be inserted.
• document: The content of the document to insert.

6. deleteOne

Delete the first document that matches the specified query.

Parameters:

• collectionName: The collection where the document to be deleted is located.
• query: Deletion conditions.

7. updateOne

Update the first document that matches the specified query and set new values.

Parameters:

• collectionName: The collection where the document will be updated.
• query: Update conditions.
• update: New values.

🔮 Future Support

In the future, the following databases will be supported:

• PostgreSQL: Execute complex SQL queries and perform table operations via natural language.
• CockroachDB: Conduct efficient SQL operations in a distributed environment.
• Redis: Utilize key - value pair storage and caching capabilities for fast data access.

⚠️ Important Note

• Confidentiality: Ensure that the MongoDB connection string is not leaked. It is recommended to use environment variables to manage sensitive information.
• Authentication: Enable authentication mechanisms in a production environment to protect the database from unauthorized access.

🤝 Contribution Guidelines

If you find any issues or have suggestions for improvement, please consider submitting a GitHub issue or a Pull Request. Your contributions will help us continuously improve the functionality and performance of the MCP Database Server.