Prompt

Die Komponente <Prompt> macht einen wiederverwendbaren Satz von Anweisungen zu einer Karte, die Leser kopieren oder in einem unterstützten KI-Tool öffnen können. Kopieren- und Öffnen-in-Aktionen verwenden den exakten, für Menschen sichtbaren Inhalt zwischen den Tags.

Grundlegende Verwendung

Jeder Prompt hat eine Kopieren-Aktion. Die einfachste Variante benötigt keine Props:

Erkläre, wie die Rotation von API-Schlüsseln funktioniert, für einen Entwickler, 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

Verwenden Sie title, um die Aufgabe zu benennen. Das mit Mintlify kompatible Prop description ersetzt die sichtbare Vorschau durch eine kürzere Zusammenfassung. Kopieren- und Öffnen-in-Aktionen verwenden weiterhin den vollständigen, für Menschen sichtbaren Inhalt zwischen den Tags.

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

- Richte dich an Backend-Entwickler.
- Beginne mit dem Nutzen für den Anwender.
- 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>

Kopieren ist immer vorhanden. Eine explizite Aktion "copy" wird aus Kompatibilitätsgründen akzeptiert, ist aber nie nötig.

Öffnen-in-Aktionen

Fügen Sie claude, cursor, chatgpt, perplexity oder gemini hinzu, damit Leser den Prompt in diesen Tools öffnen können. Jede Aktion zeigt ihr Marken-Symbol. Die erste gültige Öffnen-in-Aktion erscheint neben Kopieren. Die übrigen erscheinen im Menü „Mehr“.

Vergleiche die Abläufe für Session-Token und API-Schlüssel-Authentifizierung in diesem Repository. Nenne ihre Sicherheitsabwägungen und empfiehl, welchen Ablauf jeder Client-Typ verwenden sollte.

<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 erhalten ein label, eine HTTPS- oder HTTP-url und ein optionales Symbol. Platzieren Sie {prompt} in einem Pfadsegment, einem Query-Wert oder einem Fragment, um zu steuern, wohin der URL-kodierte Prompt geht. Wenn Sie den Platzhalter weglassen, fügt Jamdesk einen Query-Parameter prompt hinzu.

Vergleiche diesen Migrationsplan mit dem aktuellen öffentlichen API-Vertrag. Identifiziere Breaking Changes, fehlende Rollback-Schritte und die Tests, die vor dem Release nötig sind.

<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>

Benutzerdefinierte Aktions-URLs müssen http:- oder https:-URLs ohne Zugangsdaten sein. Jamdesk lehnt andere Schemata, Platzhalter in Ursprüngen oder Query-Schlüsseln und endgültige Aktions-URLs ab, die länger als 8.000 Zeichen sind. Kopieren bleibt verfügbar, wenn eine Öffnen-in-Aktion abgelehnt wird.

Benutzerdefiniertes Symbol

Setzen Sie icon auf einen Font-Awesome-Namen, eine Bild-URL oder einen Bildpfad oder inline SVG. Verwenden Sie iconType, um den Stil für einen Font-Awesome-Namen ohne Präfix auszuwählen.

Skizziere ein praxisnahes Tutorial, das einen neuen Nutzer von der Installation bis zu einer erfolgreichen API-Anfrage in unter zehn Minuten 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>

Verfügbare Namen und Stile finden Sie unter Symbole.

Kompakte Darstellungen

Die Vorschau zeigt bis zu drei Zeilen und scrollt bei einem längeren Prompt. Die Schaltfläche Erweitern öffnet den vollständigen Prompt. Setzen Sie singleLine, um die Vorschau auf eine Zeile zu kürzen. Kopieren- und Öffnen-in-Aktionen verwenden weiterhin den vollständigen, für Menschen sichtbaren Prompt.

Fasse die öffentliche API in fünf Stichpunkten zusammen:

- Authentifizierung und Lebensdauer der Token.
- Konventionen für die Paginierung.
- Ratenbegrenzungen und Hinweise zum Wiederholen.
- Fehlerformat und häufige Codes.
- Versionierung und Richtlinie zur Abkündigung.

Verwenden Sie hidePrompt mit einem Titel, wenn das Label allein den Lesern genug Kontext gibt:

Erstelle eine Migrationscheckliste für den Wechsel von API v1 zu v2. Enthalte Voraussetzungen, Code-Änderungen, Validierungsschritte, Rollback-Kriterien und die Freigabe durch den Verantwortlichen.

<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 gesetzt ist. Ohne Titel bleibt der Prompt sichtbar.

Props

Wie geht es weiter?