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 Copy y de apertura usan exactamente el contenido redactado y visible para el humano entre las etiquetas.

Uso básico

Cada Prompt incluye una acción Copy, por lo que la versión más simple no necesita ninguna prop:

Explica cómo funciona la rotación de claves de API para 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 etiquetar la tarea. La prop description, compatible con Mintlify, reemplaza la vista previa visible por un resumen más breve, mientras que el contenido redactado y visible para el humano entre las etiquetas sigue siendo el prompt completo que usan las acciones Copy y de apertura.

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

- Dirígete a los desarrolladores de 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 "copy" explícita se acepta por compatibilidad, pero Copy siempre está presente y nunca es necesario incluirla en la lista.

Acciones de apertura

Agrega claude, cursor, chatgpt, perplexity o gemini para permitir que los lectores abran el prompt en esas herramientas, cada una con su icono de marca. La primera acción de apertura válida aparece junto a Copy; las acciones adicionales aparecen en el menú More.

Compara los flujos de autenticación por token de sesión y por clave de API en este repositorio. Enumera sus compensaciones 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 de URL personalizadas

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

Compara este plan de migración con el contrato de API pública actual. Identifica los cambios incompatibles, los pasos de reversión faltantes 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 acciones personalizadas deben usar URL http: o https: sin credenciales. Jamdesk rechaza otros esquemas, marcadores de posición en los orígenes o las claves de consulta, y las URL de acción finales de más de 8,000 caracteres. Copy sigue disponible cuando se rechaza una acción de apertura.

Icono personalizado

Establece icon con un nombre de Font Awesome, una URL o ruta de imagen, o un SVG en línea. Usa iconType para seleccionar el estilo de un nombre de Font Awesome sin prefijo.

Esboza un tutorial práctico que lleve a un nuevo usuario desde la instalación hasta una solicitud de API exitosa 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 conocer los nombres y estilos disponibles.

Vistas compactas

La vista previa muestra hasta tres líneas y se desplaza cuando un prompt es más largo; el control Expand abre el prompt completo. Establece singleLine para limitar la vista previa a una sola línea en su lugar. En cualquier caso, el prompt completo y visible para el humano 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 tasa y pautas de reintento.
- Formato de errores y códigos comunes.
- Política de versionado y obsolescencia.

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

Crea una lista de verificación de migración para pasar de la API v1 a v2. Incluye los prerrequisitos, los cambios de código, los pasos de validación, los criterios de reversión y la aprobación final 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 título, Jamdesk mantiene el prompt visible para que la tarjeta siga siendo comprensible.

Props

¿Qué sigue?