plsreadme

El problema

Escribiste un README, un PRD, notas de reunión o un documento de API en markdown. Ahora necesitas compartirlo con alguien que no tiene un renderizador de markdown, no usa GitHub o simplemente necesita un enlace limpio que pueda abrir en un navegador.

plsreadme convierte cualquier markdown en una página web permanente y bellamente renderizada en un solo paso. Sin cuentas. Sin registros. Sin fricción.

✨ Características

• Compartir instantáneo — Pega markdown o sube un archivo, obtén un enlace plsrd.me

• Renderizado hermoso — Tipografía limpia, modo oscuro, adaptable a móviles

• Comentarios en línea — Los lectores pueden hacer clic en cualquier párrafo y dejar comentarios

• Modo de revisión (actual vs línea de tiempo) — Los documentos con múltiples versiones muestran por defecto comentarios del borrador actual con acceso con un clic al historial completo de la línea de tiempo

• Auto-formateo con IA — Lánzale texto sin formato; saldrá como markdown limpio

• Servidor MCP — Comparte documentos directamente desde Claude, Cursor, VS Code o cualquier cliente MCP

• Habilidad OpenClaw — Disponible en ClawHub para flujos de trabajo de agentes de IA

• Enlaces cortos — Cada documento obtiene una URL compacta plsrd.me/v/xxx

• Acceso sin procesar — Descarga el archivo .md original desde cualquier enlace compartido

• Línea de tiempo de versiones + restauración segura — /v/:id/versions + /v/:id/history + API de restauración con prioridad de archivo para una reversión rápida

• Base de autenticación Clerk — Conexión con GitHub/Google + respaldo de correo electrónico alojado por Clerk + utilidades de verificación de autenticación en el backend

• Modelo de propiedad (Fase 2) — los documentos pueden vincularse a un usuario de Clerk (owner_user_id) mientras se preservan los flujos anónimos

• Panel de Mis Enlaces (Fase 3) — página /my-links autenticada con búsqueda/ordenamiento/paginación y acciones rápidas de copiar/abrir

• Reclamación de enlaces heredados (Fase 4) — los usuarios registrados pueden reclamar enlaces anónimos antiguos probando el admin_token original

• Demo de sitio web sin configuración — No se necesita cuenta ni clave de API para probarlo en el navegador

🚀 Inicio rápido

Web

Ve a plsreadme.com, pega tu markdown, haz clic en compartir.

Rutas de autenticación y estado de lanzamiento

Orden de recomendación:

1. Prueba primero en el navegador — ruta de demostración más rápida, no requiere configuración MCP.

2. Usa MCP remoto alojado con inicio de sesión en navegador cuando se verifique el soporte del cliente.

3. Usa clave de API / respaldo de MCP local cuando el inicio de sesión interactivo no esté disponible.

Estado actual del lanzamiento:

Notas sobre el lanzamiento de MCP remoto alojado:

• https://plsreadme.com/mcp

• https://plsreadme.com/sse

Esas rutas de MCP remoto alojado están activas detrás de un inicio de sesión en navegador protegido por OAuth en el código, incluyendo /authorize, /oauth/token y /oauth/register.

Notas operativas:

• D1 doc_create_events es la tabla canónica de atribución de creación a través de flujos web, MCP alojado y MCP local.

• docs.raw_view_count rastrea cada impacto de renderizado, mientras que docs.view_count está reservado para lecturas probablemente humanas.

• Consulta docs/runbooks/auth-surface-monitoring.md para el conjunto de consultas de producción y los pasos de respuesta.

• los tokens de acceso duran aproximadamente 1 hora

• los tokens de actualización duran aproximadamente 30 días

• reconectar el mismo cliente reemplaza la concesión anterior

• cerrar sesión en el sitio web no revoca por sí mismo una concesión de editor existente

• este repositorio ahora está conectado a un enlace KV de Cloudflare Workers dedicado llamado OAUTH_KV

Cuando el inicio de sesión en el navegador no esté disponible en tu cliente, crea una clave de API personal desde /my-links y usa el respaldo de encabezado remoto alojado o el paquete local npx -y plsreadme-mcp.

Modelo de confianza de la demo del sitio web hoy:

• las creaciones anónimas del sitio web en /api/create-link requieren una concesión de verificación de navegador de corta duración

• las creaciones del sitio web registrado omiten esa concesión y mantienen la baja fricción

• la interfaz de usuario posterior a la creación ahora se ramifica en Guardar en mi cuenta, Conectar tu editor y Copiar enlace

API

curl -X POST https://plsreadme.com/api/render \
  -H "Content-Type: application/json" \
  -d '{"markdown": "# Hello World\n\nThis is my doc."}'

{
  "id": "abc123def456",
  "url": "https://plsreadme.com/v/abc123def456",
  "raw_url": "https://plsreadme.com/v/abc123def456/raw",
  "admin_token": "sk_..."
}

Guarda el admin_token: lo necesitarás para editar o eliminar:

# Update
curl -X PUT https://plsreadme.com/v/abc123def456 \
  -H "Authorization: Bearer sk_..." \
  -H "Content-Type: application/json" \
  -d '{"markdown": "# Updated content"}'

# Delete
curl -X DELETE https://plsreadme.com/v/abc123def456 \
  -H "Authorization: Bearer sk_..."

Línea de tiempo de versiones + restauración segura

Usa el endpoint de línea de tiempo para revisar el contexto de revisión durante los ciclos de iteración de IA:

curl https://plsreadme.com/v/abc123def456/versions

{
  "id": "abc123def456",
  "current_version": 5,
  "total_versions": 5,
  "versions": [
    { "version": 5, "is_current": true, "raw_url": "https://plsreadme.com/v/abc123def456/raw" },
    { "version": 4, "is_current": false, "raw_url": "https://plsreadme.com/v/abc123def456/raw?version=4" }
  ]
}

Si una edición de IA hace retroceder el documento, restaura una instantánea anterior (prioridad de archivo, no destructiva):

curl -X POST https://plsreadme.com/v/abc123def456/restore \
  -H "Authorization: Bearer sk_..." \
  -H "Content-Type: application/json" \
  -d '{"version": 4}'

La restauración tiene una tasa limitada similar a las actualizaciones (actualmente 60/hora por clave de actor) para reducir el abuso.

Para documentos propiedad de un usuario de Clerk autenticado, la actualización/eliminación/restauración también requiere esa sesión de propietario (para evitar la mutación entre usuarios), mientras que los documentos anónimos continúan funcionando solo con admin_token.

Notas de uso del modo de revisión (Borrador actual primero, Línea de tiempo bajo demanda)

El visor de documentos ahora expone controles de revisión de comentarios:

• Borrador actual — muestra solo los comentarios vinculados a la última versión del documento (por defecto cuando un documento tiene múltiples versiones).

• Línea de tiempo — muestra el historial completo de comentarios entre versiones.

Puedes obtener los mismos modos directamente desde la API:

# Latest-version comments only
curl "https://plsreadme.com/api/comments/abc123def456?view=current"

# Full timeline comments (default API behavior)
curl "https://plsreadme.com/api/comments/abc123def456?view=all"

Los enlaces del visor persisten el modo en la URL para un contexto de revisión compartible:

• https://plsreadme.com/v/abc123def456?view=current

• https://plsreadme.com/v/abc123def456?view=timeline

Para reclamar un enlace anónimo heredado en tu cuenta registrada:

curl -X POST https://plsreadme.com/api/auth/claim-link \
  -H "Authorization: Bearer <clerk-session-jwt>" \
  -H "Content-Type: application/json" \
  -d '{"id":"abc123def456","adminToken":"sk_..."}'

MCP (Editores de IA)

Recomendación actual hoy:

• usa MCP remoto alojado con inicio de sesión en navegador cuando tu cliente lo admita limpiamente

• usa el respaldo de clave de API personal cuando la autenticación remota no esté disponible o sea incómoda en ese cliente

• usa el paquete local plsreadme-mcp con PLSREADME_API_KEY para la ruta stdio más segura

Conecta tu editor a plsreadme y comparte documentos con lenguaje natural:

"Comparte este README como un enlace de plsreadme" "Convierte mi PRD en una página compartible" "Haz que estas notas de reunión sean un enlace legible"

Bucle de revisión automática MCP/agente con /versions

Para flujos de escritura de IA iterativos (borrador → crítica → revisión), los agentes pueden consumir /v/:id/versions como fuente de verdad:

1. Mantén la URL legible canónica (/v/:id) para humanos.

2. Consulta /v/:id/versions entre iteraciones.

3. Compara current_version con la última versión revisada.

4. Si cambió, obtén raw_url para la versión más nueva y ejecuta comprobaciones de revisión.

5. Si la calidad retrocede, activa opcionalmente /v/:id/restore con token de administrador + sesión de propietario.

Esto proporciona a la automatización un seguimiento de revisión determinista sin necesidad de extraer HTML.

Consulta docs/ai-iteration-versioning.md para un manual completo.

🔌 Configuración de MCP

Matriz de compatibilidad de clientes

Actual al 5 de abril de 2026:

Inicio de sesión remoto alojado (clientes compatibles)

Claude Code:

claude mcp add --transport http plsreadme https://plsreadme.com/mcp

Cursor:

{
  "mcpServers": {
    "plsreadme": {
      "url": "https://plsreadme.com/mcp"
    }
  }
}

VS Code:

{
  "servers": {
    "plsreadme": {
      "type": "http",
      "url": "https://plsreadme.com/mcp"
    }
  }
}

Windsurf:

{
  "mcpServers": {
    "plsreadme": {
      "serverUrl": "https://plsreadme.com/mcp"
    }
  }
}

Notas del ciclo de vida:

• el TTL del token de acceso es de aproximadamente 1 hora

• el TTL del token de actualización es de aproximadamente 30 días

• reconectar el mismo cliente reemplaza la concesión anterior

• cerrar sesión finaliza la sesión del sitio web pero no revoca automáticamente una concesión de editor existente

• usa GET /api/auth/mcp-grants y DELETE /api/auth/mcp-grants/:grantId para auditar o revocar concesiones de editor alojadas

Si tu cliente admite el inicio de sesión en el navegador, prefiere esta ruta. Es la configuración más limpia y mantiene los documentos propiedad vinculados a tu cuenta del sitio web automáticamente.

Respaldo de clave de API remota alojada

Crea una clave de API personal desde https://plsreadme.com/my-links primero, luego usa uno de estos:

Claude Code:

claude mcp add --transport http \
  --header "Authorization: Bearer $PLSREADME_API_KEY" \
  plsreadme-api https://plsreadme.com/mcp

Cursor:

{
  "mcpServers": {
    "plsreadme-api": {
      "url": "https://plsreadme.com/mcp",
      "headers": {
        "Authorization": "Bearer ${env:PLSREADME_API_KEY}"
      }
    }
  }
}

VS Code:

{
  "inputs": [
    {
      "type": "promptString",
      "id": "plsreadme-api-key",
      "description": "plsreadme personal API key",
      "password": true
    }
  ],
  "servers": {
    "plsreadme-api": {
      "type": "http",
      "url": "https://plsreadme.com/mcp",
      "headers": {
        "Authorization": "Bearer ${input:plsreadme-api-key}"
      }
    }
  }
}

Windsurf:

{
  "mcpServers": {
    "plsreadme-api": {
      "serverUrl": "https://plsreadme.com/mcp",
      "headers": {
        "Authorization": "Bearer ${env:PLSREADME_API_KEY}"
      }
    }
  }
}

Usuarios de endpoint remoto sin procesar:

curl -i https://plsreadme.com/mcp \
  -H "Authorization: Bearer $PLSREADME_API_KEY"

Respaldo npm local

Claude Code:

claude mcp add --transport stdio \
  --env PLSREADME_API_KEY=$PLSREADME_API_KEY \
  plsreadme -- npx -y plsreadme-mcp

Cursor: Agrega a ~/.cursor/mcp.json:

{
  "mcpServers": {
    "plsreadme": {
      "command": "npx",
      "args": ["-y", "plsreadme-mcp"],
      "env": {
        "PLSREADME_API_KEY": "${env:PLSREADME_API_KEY}"
      }
    }
  }
}

VS Code: Agrega a .vscode/mcp.json:

{
  "inputs": [
    {
      "type": "promptString",
      "id": "plsreadme-api-key",
      "description": "plsreadme personal API key",
      "password": true
    }
  ],
  "servers": {
    "plsreadme": {
      "command": "npx",
      "args": ["-y", "plsreadme-mcp"],
      "env": {
        "PLSREADME_API_KEY": "${input:plsreadme-api-key}"
      }
    }
  }
}

Claude Desktop: Agrega a claude_desktop_config.json:

{
  "mcpServers": {
    "plsreadme": {
      "command": "npx",
      "args": ["-y", "plsreadme-mcp"],
      "env": {
        "PLSREADME_API_KEY": "<paste-your-personal-api-key>"
      }
    }
  }
}

Windsurf: Agrega a ~/.codeium/windsurf/mcp_config.json:

{
  "mcpServers": {
    "plsreadme": {
      "command": "npx",
      "args": ["-y", "plsreadme-mcp"],
      "env": {
        "PLSREADME_API_KEY": "${env:PLSREADME_API_KEY}"
      }
    }
  }
}

Notas:

• stdio local ahora espera PLSREADME_API_KEY por defecto para que los nuevos documentos sean propiedad

• el modo anónimo heredado explícito aún existe con PLSREADME_ALLOW_ANONYMOUS=1

• crea tu clave desde https://plsreadme.com/my-links

Migración de configuraciones MCP anónimas existentes

Si ya usaste plsreadme-mcp de forma anónima:

1. Crea una clave de API personal desde /my-links.

2. Agrega PLSREADME_API_KEY a la configuración de tu cliente MCP.

3. Mantén PLSREADME_ALLOW_ANONYMOUS=1 solo como una muleta de compatibilidad temporal para flujos de trabajo antiguos.

4. Reclama enlaces anónimos antiguos más tarde con /api/auth/claim-link si aún tienes su admin_token.

La regla de migración es simple:

• las creaciones automatizadas/de editor nuevas deben ser propiedad por defecto

• el MCP local anónimo ahora es solo heredado y explícito

• la ruta de demo del sitio web sigue siendo de configuración cero incluso mientras la autenticación del editor se vuelve más estricta

add-mcp

npx add-mcp plsreadme-mcp

OpenClaw

clawhub install plsreadme

Docker (para registros MCP / comprobaciones de listado)

Construye y ejecuta el servidor MCP stdio en un contenedor limpio:

docker build -t plsreadme-mcp:local .
docker run --rm -i plsreadme-mcp:local

El servidor contenedorizado usa stdio (sin puertos, no se requieren variables de entorno).

🛠 Herramientas MCP