Mongodb

🚀 MongoDB Model Context Protocol (MCP) サーバー

このドキュメントは、MongoDB Model Context Protocol (MCP) サーバーの開発に関するものです。このプロジェクトでは、MongoDB データベースの機能を MCP 対応の言語モデルツールに統合することができます。

✨ 主な機能

• データベース操作：MongoDB データベースの基本的な CRUD 操作を提供します。
• インデックス管理：コレクション内のインデックスの作成、削除、および一覧表示が可能です。
• クエリツール：複雑なクエリと投影操作をサポートします。
• 型安全：Zod を使用して入力検証を行います。
• ログ記録：詳細なログ出力により、デバッグが容易になります。

🚀 クイックスタート

📦 インストール

依存関係をインストールします。

npm install

プロジェクトのビルド

npm run build

開発モードでの実行

npm run dev

テスト

npm test

データベース接続文字列

形式：mongodb://[username:password@]host[:port][/db_name][?options]

例：

# 認証付きの接続
mongodb://admin:password@localhost:27017/mydb

# 認証なしの接続
mongodb://localhost:27017/

💻 使用例

利用可能なツール

クエリツール

• listCollections：データベース内のすべてのコレクションを一覧表示します。
• find：ドキュメントをクエリし、フィルタリングと投影をサポートします。
• insertOne：コレクションに単一のドキュメントを挿入します。
• updateOne：コレクション内の単一のドキュメントを更新します。
• deleteOne：コレクション内の単一のドキュメントを削除します。

インデックスツール

• createIndex：新しいインデックスを作成します。
• dropIndex：指定されたインデックスを削除します。
• indexes：コレクション上のすべてのインデックスを一覧表示します。

⚠️ 重要提示

1. 最小限の権限を持つ専用の MongoDB ユーザーを作成してください。
2. 本番環境では管理用の資格情報を使用しないでください。
3. アクセスログ記録機能を有効にしてください。
4. 適切な読み取り/書き込み権限を設定してください。
5. 接続文字列パラメータを使用してアクセスを制限してください（例：readPreference=secondary）。
6. IP ホワイトリストによるアクセス制御を検討してください。

🔧 技術詳細

プロジェクト構築技術スタック

• TypeScript：型安全な開発に使用されます。
• MongoDB Node.js ドライバー：データベース操作を実装します。
• Zod：データ検証を行います。
• MCP SDK：サーバーインターフェイス仕様を実装します。

貢献ガイド

貢献を歓迎します！以下の手順に従ってください：

1. リポジトリを Fork します。
2. 機能ブランチを作成します（例：git checkout -b feature/amazing-feature）。
3. 変更をコミットします（例：git commit -m '添加精彩特性'）。
4. ブランチにプッシュします（例：git push origin feature/amazing-feature）。
5. Pull Request を送信します。

📄 ライセンス

このプロジェクトは MIT ライセンスに準拠しています。詳細は LICENSE ファイルを参照してください。