MCP Dbs

🚀 MCP 數據庫文檔

MCP 數據庫是一個遵循 MongoDB 協議設計的 JSON - RPC 服務，它支持多種數據庫後端，如 PostgreSQL 和 MySQL。用戶能夠通過 JSON 格式的請求來執行 SQL 查詢或 MongoDB 操作，為數據庫操作提供了便利。

🚀 快速開始

MCP 數據庫允許你通過 JSON 格式的請求執行 SQL 查詢或 MongoDB 操作。下面將為你介紹如何進行安裝和啟動服務。

📦 安裝指南

使用 Node.js 進行安裝

npm install mcp-dbs

啟動服務器

node index.js

默認監聽地址為 http://localhost:3000，配置文件位於 config.json。更多詳細信息請參考 GitHub。

💻 使用示例

數據庫支持

PostgreSQL 連接示例

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

MySQL 連接示例

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

更多配置選項請參考 config.json。

資源和服務

執行查詢

基礎用法

以下是 SQL 查詢示例：

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

高級用法

以下是不同格式的 MongoDB 查詢示例：

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

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

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

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

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

執行更新操作

基礎用法

以下是 SQL 更新示例：

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

高級用法

以下是 MongoDB 更新示例：

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

其他方法

• executeQuery: 執行查詢並返回結果。
• executeUpdate: 執行更新操作並返回執行結果。
• executeBatch: 批量執行多個 SQL 查詢。

資源

JSON - RPC 方法

execute 方法

參數：

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

返回結果：

• 如果查詢成功，返回 { status: 'success', result: [...] }
• 如果失敗，返回 { status: 'error', error: {...} }

executeUpdate 方法

參數：

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

返回結果：

• 如果更新成功，返回 { status: 'success', result: [...] }
• 如果失敗，返回 { status: 'error', error: {...} }

📚 詳細文檔

測試

運行測試：

npm test

更多詳細信息請參考 tests。

支持項目

如果這個項目對您有幫助，請考慮通過以下方式支持我們：

• 貢獻代碼：GitHub
• 購買一杯咖啡：Buy Me a Coffee

📄 許可證

本項目採用 MIT License，更多信息請參考 LICENSE。