MCP Dbs

🚀 MCP データベースドキュメント

MCP データベースは、MongoDB プロトコルに準拠した JSON - RPC サービスです。PostgreSQL や MySQL など、複数のデータベースバックエンドをサポートしています。JSON 形式のリクエストを使って SQL クエリや MongoDB 操作を実行できます。

🚀 クイックスタート

MCP データベースを使い始めるには、まずインストールとサーバーの起動を行います。

✨ 主な機能

• MongoDB プロトコルに準拠した JSON - RPC サービスを提供します。
• 複数のデータベースバックエンド（PostgreSQL、MySQL など）をサポートします。
• 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:3306/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"]
}

MongoDB（新しい形式、コレクション名を含む）

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

MongoDB（shell 形式）

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

MongoDB（直接コレクション参照 shell 形式）

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

MongoDB（生のコマンド形式）

{
  "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 を参照してください。