Defining resources

📚 Lernnotizen: Ressourcen in MCP-Servern

Ziel der Funktion:

• Ermöglichen, dass Benutzer Dokumente (z. B. durch @dokumentname) erwähnen können.
• Automatische Abfrage und Einfügung des Dokumenteninhalts in den Prompt für das KI-Modell (Claude).

Kernkonzepte von Ressourcen:

• Definition: Ressourcen erlauben dem MCP-Server, Daten an den Client zu exponieren.
• Prinzip: Es wird typischerweise eine Ressource pro eindeutiger Leseoperation definiert.
• Anwendungsfall (Dokumenten-Beispiel):
• Ressource 1: Abrufen einer Liste aller Dokumentennamen (für Autocomplete).
• Ressource 2: Abrufen des Inhalts eines einzelnen Dokuments (basierend auf ID).

Der Client-Server-Fluss (Read Resource Request):

• Benutzer gibt Eingabe (z. B. @).
• Der Client sendet eine Read Resource Request an den MCP-Server.
• Die Request enthält eine URI (Adresse der Ressource).
• Der MCP-Server führt die definierte Funktion aus.
• Der Server sendet das Ergebnis zurück (Read Resource Result).
• Der Client verarbeitet die Daten (z. B. Anzeige im Autocomplete).

Typen von Ressourcen:

• Direkte Ressourcen (Static Resources):
• Besitzen eine feste, unveränderliche URI (z. B. docs://documents).
• Die Funktion gibt direkt die gewünschten Daten zurück.
• Templierte Ressourcen (Templated Resources):
• Die URI enthält einen oder mehrere Parameter/Wildcards (z. B. docs://documents/{doc_id}).
• Der MCP SDK parst diese Parameter und übergibt sie als Keyword-Argument an die zugehörige Funktion.
• Diese werden verwendet, wenn Variabilität oder spezifische Auswahl benötigt wird.

Implementierungsdetails:

• MIME-Typ: Wird verwendet, um dem Client einen Hinweis auf das Datenformat zu geben (z. B. application/json für strukturierte Daten, text/plain für reinen Text).
• Beispiel: list_docs (Direkt Ressource):
• URI: docs://documents
• MIME-Typ: application/json
• Rückgabe: Eine Liste von Strings (Dokumentennamen/IDs).
• Beispiel: fetch_doc (Templierte Ressource):
• URI: docs://documents/{doc_id}
• MIME-Typ: text/plain
• Rückgabe: Der Inhalt des Dokuments (String).
• Sicherheit: Vor der Rückgabe muss geprüft werden, ob die angeforderte ID existiert.

Takeaways

• Ressourcen ermöglichen es dem MCP-Server, Daten (z. B. Dokumente) an den Client zu exponieren, um sie in KI-Prompts einzufügen.
• Es gibt zwei Haupttypen: Direkte (statische) Ressourcen mit fester URI und Templierte Ressourcen, deren URI Parameter (Wildcards) enthält.
• Der Client startet den Prozess durch eine Read Resource Request, die eine URI an den MCP-Server sendet, welcher die entsprechende Funktion ausführt.
• MIME-Typen werden verwendet, um dem Client das Datenformat der Rückgabe (z. B. application/json oder text/plain) mitzuteilen.