Log and progress notifications

📝 Lernnotizen: Logging und Fortschrittsanzeigen

Thema: Verbesserung der Benutzererfahrung (UX) bei lang laufenden Tool-Aufrufen (MCP Server).

• Problem: Bei zeitaufwendigen Tool-Aufrufen (z. B. Forschung) erhält der Benutzer kein Feedback und vermutet oft einen Fehler oder einen Stillstand.
• Lösung: Implementierung von Logging und Fortschrittsanzeigen.
• Server-Seite (Tool-Funktion):
• Die Tool-Funktion erhält ein context-Argument (automatisch als letzter Parameter).
• Dieses context-Objekt bietet Methoden zur Kommunikation:
• info: Zur Protokollierung von Informationen (Logging).
• report_progress: Zur Meldung des aktuellen Fortschritts.
• Aufgerufen werden automatisch Nachrichten an den Client gesendet.
• Client-Seite (Anwendung):
• Der Client muss zwei Callback-Funktionen bereitstellen:
• Ein Callback für Log-Statements.
• Ein Callback für Fortschritt-Updates.
• Diese Callbacks werden an die Tool-Funktion übergeben.
• Anwendung und Flexibilität:
• Die Art der Darstellung (z. B. Terminal-Ausgabe bei CLI, spezielle UI bei Web-Apps) liegt in der Verantwortung des Entwicklers.
• Diese Funktionen sind optional und dienen lediglich als UX-Verbesserung; sie müssen dem Benutzer nicht angezeigt werden.

Takeaways

• Ziel ist die Verbesserung der Benutzererfahrung (UX) bei zeitaufwendigen Tool-Aufrufen durch Logging und Fortschrittsanzeigen.
• Die Tool-Funktion erhält ein context-Objekt, das die Kommunikationsbasis darstellt.
• Das context-Objekt bietet die Methoden context. info (für Protokollierung) und context. report_progress (für Fortschrittsmeldungen).
• Der Client muss zwei entsprechende Callback-Funktionen bereitstellen, die an die Tool-Funktion übergeben werden.
• Die Art der Darstellung (z. B. CLI oder Web-UI) ist optional und liegt in der Verantwortung des Entwicklers.