Prompt

El componente <Prompt> convierte un conjunto reutilizable de instrucciones en una tarjeta que los lectores pueden copiar o abrir en una herramienta de IA compatible. Las acciones de copia y apertura usan exactamente el contenido redactado que ven los humanos entre las etiquetas.

Uso básico

Cada Prompt incluye una acción Copiar, así que la versión más sencilla no necesita props:

Explica cómo funciona la rotación de claves de API a un desarrollador que usa nuestra API REST por primera vez.

<Prompt>

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

</Prompt>

Título y descripción

Usa title para nombrar la tarea. La prop description, compatible con Mintlify, reemplaza la vista previa visible por un resumen más corto, mientras que el contenido redactado que ven los humanos entre las etiquetas sigue siendo el prompt completo que usan las acciones Copiar y de apertura.

Escribe una nota de versión para el nuevo endpoint de rotación de claves de API.

- Dirígete a desarrolladores backend.
- Comienza con el beneficio para el usuario.
- Incluye un ejemplo de solicitud.

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

La acción explícita "copy" se acepta por compatibilidad, pero Copiar siempre está presente y nunca es necesario indicarla.

Acciones de apertura

Añade claude, cursor, chatgpt, perplexity o gemini para que los lectores puedan abrir el prompt en esas herramientas, cada una con su icono de marca. La primera acción de apertura válida aparece junto a Copiar; las acciones adicionales aparecen en el menú Más.

Compara los flujos de autenticación mediante token de sesión y clave de API en este repositorio. Enumera sus implicaciones de seguridad y recomienda qué flujo debe usar cada tipo de cliente.

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

Acciones con URL personalizada

Las acciones personalizadas requieren un label, una url HTTPS o HTTP y un icono opcional. Coloca {prompt} en un segmento de ruta, un valor de consulta o un fragmento para controlar dónde se introduce el prompt codificado para URL. Si omites el marcador de posición, Jamdesk añade un parámetro de consulta prompt.

Compara este plan de migración con el contrato actual de la API pública. Identifica cambios incompatibles, pasos de reversión que faltan y las pruebas necesarias antes del lanzamiento.

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

Las URL de las acciones personalizadas deben ser URL http: o https: sin credenciales. Jamdesk rechaza otros esquemas, marcadores de posición en orígenes o claves de consulta y URL de acción finales de más de 8 000 caracteres. Copiar sigue disponible cuando se rechaza una acción de apertura.

Icono personalizado

Define icon como un nombre de Font Awesome, una URL o ruta de imagen, o un SVG inline. Usa iconType para seleccionar el estilo de un nombre de Font Awesome sin prefijo.

Esboza un tutorial práctico que lleve a un usuario nuevo desde la instalación hasta una solicitud de API correcta en menos de diez minutos.

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

Consulta Iconos para ver los nombres y estilos disponibles.

Vistas compactas

La vista previa muestra hasta tres líneas y se desplaza cuando el prompt es más largo; el control Ampliar abre el prompt completo. Define singleLine para limitar la vista previa a una sola línea. En cualquier caso, el prompt completo visible para humanos se sigue copiando o enviando mediante una acción de apertura.

Resume la API pública en cinco puntos:

- Autenticación y duración de los tokens.
- Convenciones de paginación.
- Límites de uso y pautas de reintento.
- Formato de errores y códigos comunes.
- Control de versiones y política de obsolescencia.

Usa hidePrompt con un título cuando la etiqueta por sí sola dé suficiente contexto a los lectores:

Crea una lista para migrar de la API v1 a la v2. Incluye requisitos previos, cambios de código, pasos de validación, criterios de reversión y aprobación del responsable.

<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 solo oculta la vista previa cuando title está presente. Sin un título, Jamdesk mantiene el prompt visible para que la tarjeta siga siendo comprensible.

Props

¿Qué sigue?