Zum Hauptinhalt springen

Einrichtungsleitfaden für lokale Entwicklungsumgebung

Dieses Dokument beschreibt, wie Sie eine vollständige MCP Gateway-Entwicklungsumgebung lokal einrichten und starten können, einschließlich aller erforderlichen Servicekomponenten.

Voraussetzungen​

Bevor Sie beginnen, stellen Sie sicher, dass Ihr System die folgende Software installiert hat:

  • Git
  • Go 1.24.1 oder höher
  • Node.js v20.18.0 oder höher
  • npm

Überblick über die Projektarchitektur​

Das MCP Gateway-Projekt besteht aus den folgenden Kernkomponenten:

  1. apiserver - Bietet Konfigurationsmanagement, Benutzeroberfläche und andere API-Dienste
  2. mcp-gateway - Kern-Gateway-Dienst, behandelt MCP-Protokollkonvertierung
  3. mock-user-svc - Simuliert Benutzerdienst für Entwicklungstests
  4. web - Management-Interface-Frontend

Starten der Entwicklungsumgebung​

1. Projekt klonen​

Besuchen Sie das MCP Gateway-Code-Repository, klicken Sie auf den Fork-Button, um das Projekt in Ihr GitHub-Konto zu forken.

2. Lokal klonen​

Klonen Sie Ihr geforktes Repository lokal:

git clone https://github.com/ihr-github-benutzername/mcp-gateway.git

3. Umgebungsabhängigkeiten initialisieren​

Wechseln Sie in das Projektverzeichnis:

cd mcp-gateway

Installieren Sie die Abhängigkeiten:

go mod tidy
cd web
npm i

4. Entwicklungsumgebung starten​

cp .env.example .env
cd web
cp .env.example .env

Hinweis: Sie können die Entwicklung mit der Standardkonfiguration ohne Änderungen starten, aber Sie können auch die Konfigurationsdateien anpassen, um Ihre Umgebungs- oder Entwicklungsanforderungen zu erfüllen, wie z.B. Wechsel von Disk, DB usw.

Hinweis: Sie benötigen möglicherweise 4 Terminalfenster, um alle Dienste auszuführen. Dieser Ansatz, mehrere Dienste auf dem Host-Rechner auszuführen, erleichtert das Neustarten und Debuggen während der Entwicklung.

4.1 mcp-gateway starten​

go run cmd/gateway/main.go

mcp-gateway wird standardmäßig unter http://localhost:5235 gestartet und bearbeitet MCP-Protokollanfragen.

4.2 apiserver starten​

go run cmd/apiserver/main.go

apiserver wird standardmäßig unter http://localhost:5234 gestartet.

4.3 mock-user-svc starten​

go run cmd/mock-user-svc/main.go

mock-user-svc wird standardmäßig unter http://localhost:5235 gestartet.

4.4 Web-Frontend starten​

npm run dev

Das Web-Frontend wird standardmäßig unter http://localhost:5236 gestartet.

Sie können jetzt auf die Verwaltungsoberfläche in Ihrem Browser unter http://localhost:5236 zugreifen. Der Standardbenutzername und das Standardpasswort werden durch Ihre Umgebungsvariablen (in der .env-Datei im Stammverzeichnis) bestimmt, insbesondere SUPER_ADMIN_USERNAME und SUPER_ADMIN_PASSWORD. Nach der Anmeldung können Sie den Benutzernamen und das Passwort in der Verwaltungsoberfläche ändern.

Häufige Probleme​

Umgebungsvariablen-Einstellungen​

Einige Dienste benötigen möglicherweise spezifische Umgebungsvariablen, um ordnungsgemäß zu funktionieren. Sie können eine .env-Datei erstellen oder diese Variablen vor dem Start des Befehls festlegen:

# Beispiel
export OPENAI_API_KEY="ihr_api_schlüssel"
export OPENAI_MODEL="gpt-4o-mini"
export APISERVER_JWT_SECRET_KEY="ihr_geheimer_schlüssel"

Nächste Schritte​

Nach dem erfolgreichen Start der lokalen Entwicklungsumgebung können Sie: