Defining resources

📚 Lernnotizen: Ressourcen in MCP-Servern

🎯 Hauptkonzept: Ressourcen (Resources)

• Definition: Ressourcen ermöglichen es einem MCP-Server, Daten an den Client zu übergeben (Exponieren).
• Zweck: Sie definieren spezifische Leseoperationen (Read Operations).
• Anwendungsfall: Automatisches Abrufen von Dokumenteninhalten, wenn ein Benutzer ein Dokument (z. B. @report. pdf) erwähnt.

⚙️ Funktionsweise der Ressourcen

• Prinzip: Eine Ressource wird für jede eindeutige Leseoperation definiert.
• Workflow (Client → Server):
• Der Client sendet eine Read Resource Request an den MCP-Server.
• Diese Anfrage enthält die URI (Adresse) der gewünschten Ressource.
• Der MCP-Server führt die definierte Funktion aus.
• Der Server sendet ein Read Resource Result zurück an den Client.

🧱 Arten von Ressourcen

• Direkte Ressourcen (Direct/Static Resources):
• Besitzen eine feste, unveränderliche URI (z. B. docs://documents).
• Die URI ist immer exakt gleich.
• Templatierte Ressourcen (Templated Resources):
• Enthalten einen oder mehrere Parameter/Wildcards in der URI (z. B. docs://documents/{doc_id}).
• Der MCP SDK parst diese Parameter und übergibt sie als Keyword Argument an die entsprechende Funktion.
• Anwendungsfall: Ermöglicht Auswahl und Variabilität (z. B. Abrufen eines spezifischen Dokuments).

🛠️ Implementierungsdetails (Beispiele)

• Ressource 1: Dokumentennamen auflisten (Autocomplete)
• URI: docs://documents (Direkt/Statisch)
• MIME Type: application/json (Hinweis auf strukturierte JSON-Daten)
• Funktion: Gibt eine Liste aller Dokumentennamen (Keys des Dokuments) zurück.
• Ressource 2: Inhalt eines Dokuments abrufen
• URI: docs://documents/{doc_id} (Templatiert)
• MIME Type: text/plain (Hinweis auf reinen Textinhalt)
• Funktion: Nimmt doc_id als Keyword Argument entgegen und gibt den Inhalt des Dokuments zurück.

🔍 MCP Inspector

• Dient zur Überprüfung und zum Testen der definierten Ressourcen.
• Man kann dort die verfügbaren statischen Ressourcen und die verfügbaren Ressourcentemplates auflisten und testen.

Takeaways

• Ressourcen definieren Leseoperationen, um Daten vom MCP-Server an den Client zu übergeben.
• Es gibt direkte (statische) Ressourcen mit fester URI und templatisierte Ressourcen mit Parametern in der URI.
• Bei templatierten Ressourcen werden die URI-Parameter als Keyword Argument an die entsprechende Server-Funktion übergeben.
• Der Workflow ist: Client sendet Read Resource Request (mit URI) → Server führt Funktion aus → Server sendet Read Resource Result zurück.