MCP サーバー (NestJS)
NestJSで構築された、堅牢でスケーラブル、かつ拡張性の高いサーバーサイドアプリケーションです。このプロジェクトは、モデルコンテキストプロトコル(MCP)サーバー実装、ファイル管理、認証、そして投稿とユーザー向けのモジュール式REST APIを提供します。
目次
Related MCP server: File Operations MCP Server
特徴
MCP サーバー: ファイル操作などのためのモデル コンテキスト プロトコルを実装します。
ファイル管理: REST エンドポイントを介してファイルをアップロード、ダウンロード、一覧表示、削除します。
認証: ローカル戦略による JWT ベースの認証。
ユーザーと投稿のモジュール: DTO とエンティティを使用したユーザーと投稿のモジュール構造。
Swagger 統合: すぐに使用できる API ドキュメント。
拡張可能: 新しいモジュールや機能を簡単に追加できます。
建築
NestJS : 効率的で信頼性が高く、スケーラブルなサーバー側アプリケーションを構築するためのプログレッシブ Node.js フレームワーク。
MCP 統合: ファイル操作にカスタム FileBrowserMCP を使用します。
モジュラー設計: 各機能は独自のモジュールにカプセル化されます。
はじめる
前提条件
インストール
環境変数
シークレットまたは構成のオーバーライド用に、ルート ディレクトリに.envファイルを作成します (オプション)。
発達
サーバーの実行
便利なコマンド
テスト
ユニットテストを実行する
エンドツーエンド(e2e)テストを実行する
テスト範囲
展開
プロジェクトをビルドします。
$ npm run buildサーバーを起動します。
$ npm run start:prod高度なデプロイメント(Docker、クラウドなど)については、 NestJS デプロイメント ドキュメントを参照してください。
APIリファレンス
サーバーの実行中、Swagger UI は
/apiで利用できます (有効な場合)。主なエンドポイント:
POST /auth/login— 認証してJWTを受け取るPOST /files/upload— ファイルをアップロードするGET /files/:id— ファイルをダウンロードするDELETE /files/:id— ファイルを削除するGET /files— ファイルを一覧表示するPOST /users— ユーザーを作成するPOST /posts— 投稿を作成する
詳細については、 src/内のコントローラー ファイルを参照してください。
プロジェクト構造
貢献
リポジトリをフォークする
機能ブランチを作成します(
git checkout -b feature/YourFeature)変更をコミットします(
git commit -am 'Add some feature')ブランチにプッシュする (
git push origin feature/YourFeature)プルリクエストを開く
コーディング標準
既存のコードスタイルに従う(ESLint設定を参照)
新しい機能のユニットテストとE2Eテストを書く
コードを文書化し、必要に応じてREADMEを更新します
Gitのセットアップ
このプロジェクトではバージョン管理にGitを使用しています。リモートオリジンは次のように設定されています。
ライセンス
Nest はMIT ライセンスです。
リソースとサポート
ご質問、問題、機能リクエストがある場合は、問題を開くか、メンテナーに連絡してください。