MCP-Server (NestJS)
Eine robuste, skalierbare und erweiterbare serverseitige Anwendung, die mit NestJS erstellt wurde. Dieses Projekt bietet eine MCP-Serverimplementierung (Model Context Protocol), Dateiverwaltung, Authentifizierung und modulare REST-APIs für Beiträge und Benutzer.
Inhaltsverzeichnis
Merkmale
- MCP-Server : Implementiert Model Context Protocol für Dateioperationen und mehr.
- Dateiverwaltung : Hochladen, Herunterladen, Auflisten und Löschen von Dateien über REST-Endpunkte.
- Authentifizierung : JWT-basierte Authentifizierung mit lokaler Strategie.
- Benutzer- und Postmodule : Modulare Struktur für Benutzer und Posts mit DTOs und Entitäten.
- Swagger-Integration : sofort einsatzbereite API-Dokumentation.
- Erweiterbar : Fügen Sie einfach neue Module und Funktionen hinzu.
Architektur
- NestJS : Progressives Node.js-Framework zum Erstellen effizienter, zuverlässiger und skalierbarer serverseitiger Anwendungen.
- MCP-Integration : Verwendet einen benutzerdefinierten FileBrowserMCP für Dateivorgänge.
- Modulares Design : Jede Funktion ist in einem eigenen Modul gekapselt.
Erste Schritte
Voraussetzungen
Installation
Umgebungsvariablen
Erstellen Sie im Stammverzeichnis eine .env
Datei für alle Geheimnisse oder Konfigurationsüberschreibungen (optional).
Entwicklung
Ausführen des Servers
Nützliche Befehle
Testen
Führen Sie Unit-Tests durch
Führen Sie End-to-End-Tests (e2e) durch
Testabdeckung
Einsatz
- Erstellen Sie das Projekt:
- Starten Sie den Server:
- Informationen zur erweiterten Bereitstellung (Docker, Cloud usw.) finden Sie in den NestJS-Bereitstellungsdokumenten .
API-Referenz
- Die Swagger-Benutzeroberfläche ist (sofern aktiviert) unter
/api
verfügbar, wenn der Server läuft. - Hauptendpunkte:
POST /auth/login
– Authentifizieren und JWT empfangenPOST /files/upload
– Eine Datei hochladenGET /files/:id
Eine Datei herunterladenDELETE /files/:id
— Eine Datei löschenGET /files
– Dateien auflistenPOST /users
— Einen Benutzer erstellenPOST /posts
– Einen Beitrag erstellen
Weitere Einzelheiten finden Sie in den Controllerdateien in src/
.
Projektstruktur
Beitragen
- Forken Sie das Repository
- Erstellen Sie Ihren Feature-Zweig (
git checkout -b feature/YourFeature
) - Übernehmen Sie Ihre Änderungen (
git commit -am 'Add some feature'
) - Pushen zum Zweig (
git push origin feature/YourFeature
) - Öffnen einer Pull-Anfrage
Kodierungsstandards
- Befolgen Sie den vorhandenen Codestil (siehe ESLint-Konfiguration).
- Schreiben Sie Unit- und E2E-Tests für neue Funktionen
- Dokumentieren Sie Ihren Code und aktualisieren Sie die README-Datei nach Bedarf
Git-Setup
Dieses Projekt verwendet Git zur Versionskontrolle. Der Remote-Ursprung ist wie folgt eingestellt:
Lizenz
Nest ist vom MIT lizenziert .
Ressourcen und Support
- NestJS-Dokumentation
- Discord-Community
- Kurse
- NestJS-Entwicklertools
- Unternehmensunterstützung
- Jobbörse
- Autor
Bei Fragen, Problemen oder Funktionsanfragen öffnen Sie bitte ein Problem oder wenden Sie sich an den Betreuer.
This server cannot be installed
Eine robuste serverseitige Anwendung, die das Model Context Protocol (MCP) für Dateivorgänge implementiert und Authentifizierung sowie modulare REST-APIs für die Verwaltung von Dateien, Benutzern und Posts bereitstellt.
Related MCP Servers
- -securityAlicense-qualityMCP Server simplifies the implementation of the Model Context Protocol by providing a user-friendly API to create custom tools and manage server workflows efficiently.Last updated -43TypeScriptMIT License
- -securityAlicense-qualityMCP Server provides a simpler API to interact with the Model Context Protocol by allowing users to define custom tools and services to streamline workflows and processes.Last updated -132TypeScriptMIT License
- -securityAlicense-qualityA Model Context Protocol (MCP) server that allows AI models to safely access and interact with local file systems, enabling reading file contents, listing directories, and retrieving file metadata.Last updated -471JavaScriptMIT License
- AsecurityFlicenseAqualityA Model Context Protocol (MCP) server that interacts with system APIs, allowing users to check connections, search employees, register breakfast, and update chemical information by shifts.Last updated -2176JavaScript