Prompt

Die Komponente <Prompt> wandelt eine wiederverwendbare Anweisungsfolge in eine Karte um, die Leser kopieren oder in einem unterstützten KI-Tool öffnen können. Die Aktionen zum Kopieren und Öffnen verwenden den exakt verfassten, für Menschen sichtbaren Inhalt zwischen den Tags.

Grundlegende Verwendung

Jeder Prompt enthält eine Copy-Aktion. Daher benötigt die einfachste Variante keine Props:

Erkläre, wie die Rotation von API-Schlüsseln für einen Entwickler funktioniert, der unsere REST API zum ersten Mal verwendet.

<Prompt>

Explain how API key rotation works for a developer using our REST API for the first time.

</Prompt>

Titel und Beschreibung

Verwende title, um die Aufgabe zu beschriften. Die mit Mintlify kompatible Prop description ersetzt die sichtbare Vorschau durch eine kürzere Zusammenfassung, während der für Menschen sichtbare, verfasste Inhalt zwischen den Tags der vollständige Prompt bleibt, den Copy- und Öffnen-in-Aktionen verwenden.

Verfasse eine Release-Notiz für den neuen Endpoint zur Rotation von API-Schlüsseln.

- Richte dich an Backend-Entwickler.
- Stelle den Nutzen für den Benutzer an den Anfang.
- Füge ein Anfragebeispiel hinzu.

<Prompt
  title="Draft a release note"
  description="Write a concise release note for a developer audience."
  actions={["copy", "claude"]}
>
Write a release note for the new API key rotation endpoint.

- Address backend developers.
- Lead with the user benefit.
- Include one request example.

</Prompt>

Die explizite Aktion "copy" wird aus Kompatibilitätsgründen akzeptiert, aber Copy ist immer vorhanden und muss nicht aufgeführt werden.

Öffnen-in-Aktionen

Füge claude, cursor, chatgpt, perplexity oder gemini hinzu, damit Leser den Prompt in diesen Tools öffnen können. Jede Aktion verwendet das Markensymbol des jeweiligen Tools. Die erste gültige Öffnen-in-Aktion erscheint neben Copy; weitere Aktionen erscheinen im Menü More.

Vergleiche die Authentifizierungsabläufe mit Sitzungstoken und API-Schlüsseln in diesem Repository. Liste ihre Sicherheitsabwägungen auf und empfehle, welchen Ablauf die einzelnen Clienttypen verwenden sollten.

<Prompt
  title="Compare authentication flows"
  actions={["claude", "cursor", "chatgpt", "perplexity", "gemini"]}
>
Compare the session-token and API-key authentication flows in this repository.
List their security tradeoffs and recommend which flow each client type should use.

</Prompt>

Benutzerdefinierte URL-Aktionen

Benutzerdefinierte Aktionen benötigen ein label, eine HTTPS- oder HTTP-url und optional ein Symbol. Setze {prompt} in ein Pfadsegment, einen Abfragewert oder ein Fragment, um festzulegen, wohin der URL-codierte Prompt eingefügt wird. Wenn du den Platzhalter weglässt, fügt Jamdesk einen prompt-Abfrageparameter hinzu.

Vergleiche diesen Migrationsplan mit dem aktuellen öffentlichen API-Vertrag. Ermittle inkompatible Änderungen, fehlende Rollback-Schritte und die vor dem Release erforderlichen Tests.

<Prompt
  title="Research this migration"
  actions={[
    {
      label: "Search the web",
      url: "https://www.google.com/search?q={prompt}",
      icon: "magnifying-glass",
    },
    "claude",
  ]}
>
Compare this migration plan with the current public API contract. Identify
breaking changes, missing rollback steps, and tests needed before release.

</Prompt>

URLs benutzerdefinierter Aktionen müssen anmeldeinformationsfreie http:- oder https:-URLs verwenden. Jamdesk lehnt andere Schemas, Platzhalter in Origins oder Abfrageschlüsseln sowie endgültige Aktions-URLs mit mehr als 8.000 Zeichen ab. Copy bleibt verfügbar, wenn eine Öffnen-in-Aktion abgelehnt wird.

Benutzerdefiniertes Symbol

Setze icon auf einen Font Awesome-Namen, eine Bild-URL oder einen Bildpfad oder ein Inline-SVG. Verwende iconType, um den Stil eines nicht präfixierten Font Awesome-Namens auszuwählen.

Skizziere ein praxisnahes Tutorial, das einen neuen Benutzer in weniger als zehn Minuten von der Installation zu einer erfolgreichen API-Anfrage führt.

<Prompt title="Plan a tutorial" icon="pen-nib" iconType="duotone">

  Outline a hands-on tutorial that gets a new user from installation to a
  successful API request in under ten minutes.

</Prompt>

Unter Icons findest du verfügbare Namen und Stile.

Kompakte Darstellungen

Die Vorschau zeigt bis zu drei Zeilen und wird scrollbar, wenn ein Prompt länger ist. Die Steuerung Expand öffnet den vollständigen Prompt. Setze singleLine, um die Vorschau stattdessen auf eine einzelne Zeile zu begrenzen. In beiden Fällen wird der vollständige, für Menschen sichtbare Prompt weiterhin kopiert oder von einer Öffnen-in-Aktion gesendet.

Fasse die öffentliche API in fünf Aufzählungspunkten zusammen:

- Authentifizierung und Token-Laufzeiten.
- Konventionen für die Seitennummerierung.
- Ratenbegrenzungen und Hinweise zu Wiederholungsversuchen.
- Fehlerformat und gängige Codes.
- Versionierung und Richtlinie zur Einstellung von Funktionen.

Verwende hidePrompt zusammen mit einem Titel, wenn die Bezeichnung allein den Lesern genügend Kontext bietet:

Erstelle eine Migrationscheckliste für den Wechsel von API v1 zu v2. Füge Voraussetzungen, Codeänderungen, Validierungsschritte, Rollback-Kriterien und die Genehmigung durch den Verantwortlichen hinzu.

<Prompt title="Summarize the API">

  Summarize the public API in five bullets:

  - Authentication and token lifetimes.
  - Pagination conventions.
  - Rate limits and retry guidance.
  - Error format and common codes.
  - Versioning and deprecation policy.

</Prompt>

<Prompt title="Generate a migration checklist" hidePrompt actions={["claude"]}>

  Create a migration checklist for moving from API v1 to v2. Include
  prerequisites, code changes, validation steps, and rollback criteria.

</Prompt>

hidePrompt blendet die Vorschau nur aus, wenn title vorhanden ist. Ohne Titel hält Jamdesk den Prompt sichtbar, damit die Karte verständlich bleibt.

Props

Wie geht es weiter?