Den vollständigen Index der Dokumentation findest du in llms.txt. Die Markdown-Version einer Dokumentationsseite erhältst du, indem du .md an die URL der Seite anhängst.
Hauptnavigation
Design

Anwendungsfälle für dein Plugin sammeln

Lege fest, welche Aufgaben sich mit deinem Plugin erledigen lassen sollen.

Liste zuerst auf, welche Aufgaben dein Plugin aus Sicht der Nutzenden erledigen soll. Der Name, die Beschreibung, die Skills und Tools sowie die Anbindung an ein bestehendes Produkt wecken Erwartungen. Dein Plugin sollte diese Erwartungen erfüllen. Wenn du eine davon bewusst ausklammerst, solltest du einen Grund dafür haben.

Daraus ergibt sich, welche Bestandteile dein Plugin braucht:

  • Ergänze einen Skill, wenn Anleitungen, Beispiele oder mitgelieferte Ressourcen das Modell durch den Arbeitsablauf führen können.
  • Ergänze einen MCP-Server, wenn der Arbeitsablauf Live-Daten, Authentifizierung, Tools mit kontrolliertem Zugriff oder Code erfordert, der auf einer von dir betriebenen Infrastruktur läuft.
  • Ergänze den MCP-Server nur dann um eine Benutzeroberfläche, wenn die visuelle Interaktion einen Teil des Arbeitsablaufs deutlich verbessert.

Von den Erwartungen der Nutzenden ausgehen

Stell dir vor, jemand hat dein Plugin installiert, aber die Dokumentation noch nicht gelesen. Welche Aufgaben würde diese Person dem Plugin wohl stellen?

Um typische Anfragen zu sammeln, schau dir Folgendes an:

  • Aufgaben, die Menschen bereits mit deinem Produkt oder Dienst erledigen.
  • Interviews mit Nutzenden, Supportanfragen, Suchanfragen und Wünsche nach neuen Funktionen.
  • Gängige Begriffe, mit denen Menschen dein Produkt, deine Daten und deine Arbeitsabläufe beschreiben.
  • Behelfslösungen, bei denen Daten von einem Tool in ein anderes kopiert werden müssen.
  • Den Namen des Plugins, den Verzeichniseintrag und die Prompts für den Einstieg.

Berücksichtige sowohl direkte Anfragen, die dein Plugin beim Namen nennen, als auch indirekte Anfragen, die das Ziel beschreiben. Ein Plugin für Projektmanagement muss zum Beispiel möglicherweise beide Anfragen bearbeiten können: „Zeig mir mein Board für den Acme-Launch“ und „Was blockiert den Launch?“

Beschränke die Ideensammlung nicht auf Arbeitsabläufe, die deine aktuelle API unterstützt. Halte zuerst fest, was Menschen erwarten. Prüfe anschließend, welche dieser Erwartungen du sicher und zuverlässig erfüllen kannst.

Eine Übersicht der Anwendungsfälle erstellen

Halte für jeden Anwendungsfall Folgendes fest:

Feld Leitfrage
Ziel der Person Was möchte die Person erreichen?
Beispielanfragen Wie könnte sie ihre Anfrage direkt oder indirekt formulieren?
Erwartetes Ergebnis Woran würde die Person erkennen, dass die Interaktion erfolgreich war?
Erforderlicher Kontext Welche Informationen, Kontozugriffe oder Ausgangsbedingungen sind erforderlich?
Funktion des Plugins Reicht ein Skill aus oder ist ein MCP-Tool nötig?
Sicherheitsgrenzen Könnte das Plugin dabei Daten offenlegen, einen Zustand ändern, Geld ausgeben oder Auswirkungen auf eine andere Person haben?
Geplanter Funktionsumfang Willst du den Anwendungsfall in der ersten Version unterstützen, auf später verschieben oder bewusst ausschließen?

Fasse Anfragen zusammen, die dasselbe Ziel verfolgen. „Liste meine offenen Aufgaben auf“, „Was muss ich heute erledigen?“ und „Zeig mir überfällige Aufgaben“ können zu einem einzigen Anwendungsfall gehören: Die Person möchte ihre Aufgaben durchsehen und braucht dafür unterschiedliche Filter. Drei separate Funktionen sind dafür möglicherweise unnötig.

Funktionsumfang prüfen

Gleiche jede Erwartung mit den geplanten Funktionen des Plugins ab:

  1. Prüfe für jeden unterstützten Anwendungsfall, ob das Plugin alle Schritte von der Anfrage bis zu einem brauchbaren Ergebnis abdeckt.
  2. Ermittle, welche Skills, Tools, Daten oder Berechtigungen fehlen und welche Fehlerzustände du noch berücksichtigen musst.
  3. Suche nach Tools, die technische Operationen bereitstellen, mit denen sich aber kein erkennbares Ziel der Nutzenden vollständig erreichen lässt.
  4. Prüfe, ob Schreibaktionen eine angemessene Autorisierung und Bestätigung vorsehen.
  5. Stelle sicher, dass das Plugin seine Grenzen erklären und einen sinnvollen nächsten Schritt vorschlagen kann.

Ein Plugin sollte nur so viel versprechen, wie es vom erwarteten Arbeitsablauf tatsächlich abdeckt. Wenn sich Projekte erstellen, aber weder auflisten noch im Detail ansehen oder aktualisieren lassen, ergänze die fehlenden Funktionen oder beschreibe den Einsatzbereich des Plugins enger.

Bewusste Ausschlüsse dokumentieren

Du musst nicht jede denkbare Anfrage unterstützen. Für jeden wichtigen Ausschluss solltest du aber einen guten Grund haben, zum Beispiel:

  • Die Aktion würde ein unvertretbares Risiko für die Sicherheit oder den Datenschutz darstellen.
  • Das zugrunde liegende Produkt oder die API unterstützt die Aktion nicht zuverlässig.
  • Der Arbeitsablauf erfordert Berechtigungen, die das Plugin nicht überprüfen kann.
  • Ohne Informationen, auf die das Plugin keinen Zugriff hat, wäre das Ergebnis irreführend.
  • Der Anwendungsfall ist für die erste Version nicht vorgesehen, und der Verzeichniseintrag des Plugins macht das deutlich.

Halte diese Entscheidungen fest. Berücksichtige sie, wenn du den Einsatzbereich der Skills festlegst, Tools beschreibst, definierst, wie das Plugin Anfragen ablehnt, Testfälle erstellst und den öffentlichen Verzeichniseintrag formulierst.

Die Umsetzung aus den Anwendungsfällen ableiten

Wähle für jeden unterstützten Anwendungsfall die kleinste Lösung, die ihn vollständig abdeckt:

Verwende die Übersicht der Anwendungsfälle als Testplan. Ergänze typische direkte und indirekte Anfragen sowie Beispiele für Grenzfälle und für Anfragen außerhalb des vorgesehenen Funktionsumfangs. Prüfe anschließend für jede Anfrage, ob sich das fertige Plugin wie vorgesehen verhält.

Wenn dein Plugin Live-Daten oder kontrollierte Aktionen benötigt, fahre mit dem Abschnitt Tools definieren fort.