Mongodb

🚀 MongoDB Model Context Protocol (MCP) Server

This project enables the integration of MongoDB database capabilities into MCP - supported language model tools.

🚀 Quick Start

Install Dependencies

npm install

Build the Project

npm run build

Run in Development Mode

npm run dev

Testing

npm test

✨ Features

• Database Operations: Provides basic CRUD operations for MongoDB databases.
• Index Management: Create, delete, and list indexes in collections.
• Query Tools: Supports complex queries and projection operations.
• Type Safety: Uses Zod for input validation.
• Logging: Detailed log output for easy debugging.

📦 Installation

Database Connection String

Format: mongodb://[username:password@]host[:port][/db_name][?options]

Examples:

# Authenticated connection
mongodb://admin:password@localhost:27017/mydb

# Unauthenticated connection
mongodb://localhost:27017/

💻 Usage Examples

Query Tools

• listCollections: List all collections in the database.
• find: Query documents with filtering and projection support.
• insertOne: Insert a single document into a collection.
• updateOne: Update a single document in a collection.
• deleteOne: Delete a single document from a collection.

Index Tools

• createIndex: Create a new index.
• dropIndex: Delete a specified index.
• indexes: List all indexes on a collection.

📚 Documentation

Security Precautions

1. Create a dedicated MongoDB user with minimal privileges.
2. Avoid using administrative credentials in a production environment.
3. Enable access logging.
4. Set appropriate read and write permissions.
5. Use connection string parameters to restrict access (e.g., readPreference=secondary).
6. Consider enabling IP whitelist access control.

Project Build Technology Stack

• TypeScript: For type - safe development.
• MongoDB Node.js Driver: To implement database operations.
• Zod: For data validation.
• MCP SDK: To implement server interface specifications.

Contribution Guidelines

Contributions are welcome! Please follow these steps:

1. Fork the repository.
2. Create a feature branch (e.g., git checkout -b feature/amazing - feature).
3. Commit your changes (e.g., git commit -m 'Add amazing feature').
4. Push to the branch (e.g., git push origin feature/amazing - feature).
5. Submit a Pull Request.

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.