MCP Dbs

🚀 MCP Database Documentation

The MCP Database is a JSON-RPC service designed following the MongoDB protocol, supporting multiple database backends (such as PostgreSQL and MySQL). It allows users to execute SQL queries or MongoDB operations through JSON-formatted requests.

🚀 Quick Start

📦 Installation

Install using Node.js:

npm install mcp-dbs

Start the server:

node index.js

The default listening address is http://localhost:3000, and the configuration file is located at config.json. For more detailed information, please refer to GitHub.

💻 Database Support

PostgreSQL Connection Example

{
  "connectionString": "postgresql://username:password@localhost:5432/mydb"
}

MySQL Connection Example

{
  "connectionString": "mysql://username:password@localhost:3006/mydb"
}

For more configuration options, please refer to config.json.

💻 Resource and Service Usage

Execute Queries

SQL Query Example

{
  "connectionId": "my-postgres-db",
  "query": "SELECT * FROM users WHERE age > $1",
  "params": [21]
}

MongoDB Query Example

{
  "connectionId": "my-mongodb-db",
  "query": "[{\"$match\": {\"age\": {\"$gt\": 21}}}, {\"$sort\": {\"name\": 1}}]",
  "params": ["users"]
}

MongoDB (New Format, Including Collection Name)

{
  "connectionId": "my-mongodb-db",
  "query": "{\"collection\": \"users\", \"pipeline\": [{\"$match\": {\"age\": {\"$gt\": 21}}}, {\"$sort\": {\"name\": 1}}]}"
}

MongoDB (Shell Format)

{
  "connectionId": "my-mongodb-db",
  "query": "db.getCollection('users').find({\"age\": {\"$gt\": 21}})"
}

MongoDB (Direct Collection Reference Shell Format)

{
  "connectionId": "my-mongodb-db",
  "query": "db.users.find({\"age\": {\"$gt\": 21}})"
}

MongoDB (Raw Command Format)

{
  "connectionId": "my-mongodb-db", 
  "query": "{\"find\": \"users\", \"filter\": {\"age\": {\"$gt\": 21}}}"
}

Execute Update Operations

SQL Update Example

{
  "connectionId": "my-postgres-db",
  "query": "UPDATE users SET age = $1 WHERE id = $2",
  "params": [25, 1]
}

MongoDB Update Example

{
  "connectionId": "my-mongodb-db",
  "query": "db.users.update({\"_id\": \"1\"}, {\"$set\": {\"age\": 25}})"
}

Other Methods

• executeQuery: Execute a query and return the result.
• executeUpdate: Execute an update operation and return the execution result.
• executeBatch: Execute multiple SQL queries in batch.

📚 JSON-RPC Methods

execute Method

Parameters:

{
  "method": "execute",
  "params": {
    "connectionId": string,
    "query": string,
    "params": array (optional)
  }
}

Return Results:

• If the query is successful, return { status: 'success', result: [...] }.
• If it fails, return { status: 'error', error: {...} }.

executeUpdate Method

Parameters:

{
  "method": "executeUpdate",
  "params": {
    "connectionId": string,
    "query": string,
    "params": array (optional)
  }
}

Return Results:

• If the update is successful, return { status: 'success', result: [...] }.
• If it fails, return { status: 'error', error: {...} }.

📚 Development Documentation

Testing

Run tests:

npm test

For more detailed information, please refer to tests.

Support the Project

If this project is helpful to you, please consider supporting us in the following ways:

• Contribute code: GitHub
• Buy us a coffee: Buy Me a Coffee

📄 License

This project uses the MIT License. For more information, please refer to LICENSE.