plsreadme

Paste markdown. Get a beautiful, shareable link. Done.

Website · MCP Package · Request a Feature

---

The Problem

You wrote a README, a PRD, meeting notes, or an API doc in markdown. Now you need to share it with someone who doesn't have a markdown renderer, doesn't use GitHub, or just needs a clean link they can open in a browser.

plsreadme turns any markdown into a permanent, beautifully rendered web page in one step. No accounts. No sign-ups. No friction.

✨ Features

• Instant sharing — Paste markdown or upload a file, get a plsrd.me link
• Beautiful rendering — Clean typography, dark mode, mobile-responsive
• Inline comments — Readers can click any paragraph and leave feedback
• Review mode (current vs timeline) — Multi-version docs default to Current draft feedback with one-click access to full Timeline history
• AI auto-formatting — Throw raw text at it; it comes out as clean markdown
• MCP server — Share docs directly from Claude, Cursor, VS Code, or any MCP client
• OpenClaw skill — Available on ClawHub for AI agent workflows
• Short links — Every doc gets a compact plsrd.me/v/xxx URL
• Raw access — Download the original .md file from any shared link
• Version timeline + safe restore — /v/:id/versions + /v/:id/history + archive-first restore API for fast rollback
• Clerk auth foundation — GitHub/Google sign-in wiring + Clerk-hosted email fallback + backend auth verification utilities
• Ownership model (Phase 2) — docs can be linked to a Clerk user (owner_user_id) while preserving anonymous flows
• My Links dashboard (Phase 3) — authenticated /my-links page with search/sort/pagination and quick copy/open actions
• Legacy link claiming (Phase 4) — signed-in users can claim older anonymous links by proving the original admin_token
• Zero config — No API keys needed for basic usage

🚀 Quick Start

Web

Go to plsreadme.com, paste your markdown, click share.

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_..."
}

Save the admin_token — you'll need it to edit or delete:

# 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_..."

Version timeline + safe restore

Use the timeline endpoint to review revision context during AI iteration cycles:

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" }
  ]
}

If an AI edit regresses the doc, restore a prior snapshot (archive-first, non-destructive):

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

Restore is rate-limited similarly to updates (currently 60/hour per actor key) to reduce abuse.

For docs owned by an authenticated Clerk user, update/delete/restore also require that owner session (to prevent cross-user mutation), while anonymous docs continue to work with admin_token only.

Review mode usage notes (Current draft first, Timeline on demand)

The document viewer now exposes comment review controls:

• Current draft — shows only comments tied to the latest doc version (default when a doc has multiple versions).
• Timeline — shows the full cross-version comment history.

You can fetch the same modes directly from the 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"

Viewer links persist the mode in the URL for shareable review context:

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

To claim a legacy anonymous link into your signed-in account:

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 (AI Editors)

Connect your editor to plsreadme and share docs with natural language:

"Share this README as a plsreadme link" "Turn my PRD into a shareable page" "Make these meeting notes into a readable link"

MCP/agent auto-review loop with /versions

For iterative AI writing flows (draft → critique → revise), agents can consume /v/:id/versions as the source of truth:

1. Keep the canonical readable URL (/v/:id) for humans.
2. Poll /v/:id/versions between iterations.
3. Compare current_version to the last reviewed version.
4. If changed, fetch raw_url for the newest version and run review checks.
5. If quality regresses, optionally trigger /v/:id/restore with admin token + owner session.

This gives automation deterministic revision tracking without scraping HTML.

See docs/ai-iteration-versioning.md for a full playbook.

🔌 MCP Setup

Claude Code

claude mcp add plsreadme -- npx -y plsreadme-mcp

Cursor

Add to ~/.cursor/mcp.json:

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

VS Code

Add to your settings.json:

{
  "mcp": {
    "servers": {
      "plsreadme": {
        "command": "npx",
        "args": ["-y", "plsreadme-mcp"]
      }
    }
  }
}

Claude Desktop

Add to claude_desktop_config.json:

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

Windsurf

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

Remote MCP (zero install)

Some clients support remote MCP endpoints directly:

https://plsreadme.com/mcp

add-mcp

npx add-mcp plsreadme-mcp

OpenClaw

clawhub install plsreadme

Docker (for MCP registries / listing checks)

Build and run the stdio MCP server in a clean container:

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

The containerized server uses stdio (no ports, no env vars required).

🛠 MCP Tools

Tool	What it does
plsreadme_share_file	Share a local file by path → returns shareable link. Re-sharing updates the same link.
plsreadme_share_text	Share markdown or plain text directly → returns shareable link
plsreadme_update	Update an existing doc with new content (by ID or file path)
plsreadme_delete	Delete a shared doc permanently (by ID or file path)
plsreadme_list	List all documents you've shared from this project

Prompts:

• share-document — Guided flow to share content as a readable link
• refactor-and-share — Uses your AI model to refactor raw text into polished markdown, then shares it

Plain text input? No problem — the MCP auto-structures it into markdown, or you can use the refactor-and-share prompt to leverage your AI's reasoning for a polished result.

.plsreadme Record File

The MCP server tracks your shared documents in a .plsreadme JSON file in your project root. This stores document IDs, URLs, and admin tokens needed for editing and deleting.

⚠️ Add .plsreadme to your .gitignore — it contains admin tokens. The tool will warn you if it's missing.

🏗 Architecture

Built on Cloudflare's edge stack for speed everywhere:

┌─────────────┐     ┌──────────────────┐     ┌─────────┐
│  Web / API  │────▶│  Cloudflare      │────▶│   R2    │
│  MCP Client │     │  Workers (Hono)  │     │ (docs)  │
└─────────────┘     └──────────────────┘     └─────────┘
                           │
                    ┌──────┴──────┐
                    │     D1      │
                    │ (metadata)  │
                    └─────────────┘

• Hono — Lightweight web framework on Workers
• Cloudflare D1 — SQLite at the edge for metadata, comments, analytics
• Cloudflare R2 — Object storage for markdown documents
• Durable Objects — Stateful MCP server endpoint
• Workers AI — Optional fallback for text-to-markdown conversion

📁 Project Structure

plsreadme/
├── worker/
│   ├── index.ts              # Main worker entry
│   ├── auth.ts               # Clerk JWT verification utilities/middleware
│   ├── routes/
│   │   ├── auth.ts           # Auth config/session/protected identity endpoints
│   │   ├── docs.ts           # Document creation & rendering
│   │   ├── comments.ts       # Inline commenting system
│   │   ├── convert.ts        # AI text→markdown conversion
│   │   ├── analytics.ts      # View tracking
│   │   ├── links.ts          # Short link handling
│   │   └── waitlist.ts       # Waitlist & notifications
│   ├── mcp-agent.ts          # Remote MCP server (Durable Object)
│   └── types.ts              # TypeScript types
├── packages/
│   └── mcp/                  # npm package: plsreadme-mcp
│       └── src/index.ts      # MCP server (stdio transport)
├── public/                   # Static assets & landing pages
├── db/
│   └── schema.sql            # D1 database schema
├── docs/
│   ├── ai-iteration-versioning.md # Version timeline/restore patterns for human + agent loops
│   ├── auth-clerk.md              # Auth setup + environment checklist
│   └── runbooks/
│       └── legacy-link-claim-rollout.md
├── skill/
│   └── plsreadme/            # OpenClaw agent skill
└── wrangler.jsonc             # Cloudflare Workers config

🔧 Development

# Install dependencies
npm install

# Run locally
npm run dev

# Deploy
npm run deploy

# Bootstrap schema (fresh local DB)
npm run db:migrate:local

# Audit unapplied migrations (remote + local)
npm run db:migrations:status

# Apply migration files explicitly
npm run db:migrations:apply        # remote
npm run db:migrations:apply:local  # local

Ownership phase migration notes:

• wrangler.jsonc points migrations_dir to db/migrations, so migration status is auditable with explicit list/apply commands.
• Apply db/migrations/004_owner_user_id.sql in existing environments before relying on ownership filters.
• Legacy rows are intentionally backfilled as owner_user_id = NULL (anonymous/public behavior preserved).
• Write routes still run a safe ownership schema ensure step (duplicate-column tolerant) for mixed-env rollout safety.
• See docs/migrations.md for the explicit audit/apply workflow.

MCP package release

plsreadme-mcp is published from packages/mcp by pushing an mcp-v* tag (see .github/workflows/publish-mcp.yml).

cd packages/mcp
npm version patch   # or minor/major
cd ../..
git add packages/mcp/package.json packages/mcp/package-lock.json
VERSION=$(node -p "require('./packages/mcp/package.json').version")
git commit -m "chore(mcp): release v${VERSION}"
git tag "mcp-v${VERSION}"
# push commit + tag from your machine to trigger npm publish workflow

Environment Variables

Start from .env.example and set values in your local/dev/prod environment.

Cloudflare tip: non-sensitive values can live in vars; sensitive values should be set with wrangler secret put.

Variable	Required	Description
OPENAI_API_KEY	No	OpenAI key for /api/convert text→markdown
DISCORD_WEBHOOK_URL	No	Waitlist signup notifications
DISCORD_LINK_WEBHOOK_URL	No	New link creation notifications
RESEND_API_KEY	No	Email notifications
NOTIFICATION_EMAIL	No	Email recipient for notifications
CLERK_PUBLISHABLE_KEY	For auth	Clerk publishable key for frontend auth wiring (social + email fallback)
CLERK_JWT_ISSUER	For auth	Clerk JWT issuer used by worker verification
CLERK_JWT_AUDIENCE	Optional	Expected audience claim for Clerk JWTs
CLERK_SIGN_IN_URL	Optional	Clerk-hosted sign-in URL hint (default /sign-in)
CLERK_SIGN_UP_URL	Optional	Clerk-hosted sign-up URL hint (default /sign-up)
CLERK_SECRET_KEY	Optional	Reserved for future server-side Clerk integrations

If OAuth credentials are not configured yet, users can still click Sign in / Use email instead and complete auth through the Clerk-hosted email flow immediately.

Frontend auth shell notes:

• /app.html and /my-links use public/clerk-auth-shell.js (Clerk-native browser SDK wiring).
• Authenticated frontend API calls should read bearer tokens through window.plsreadmeGetAuthToken().

The core sharing functionality still requires zero configuration. Clerk auth, AI conversion, and notifications are opt-in.

For the full auth setup checklist, see docs/auth-clerk.md.

📊 Limits

Limit	Value
Max document size	200 KB
Upload rate limit	30/hour per actor key
Update/restore rate limit	60/hour per actor key
AI convert rate limit	10/hour per IP
Link lifetime	Permanent

🤝 Contributing

Feature ideas? Bug reports? Open an issue.

PRs welcome for bug fixes and improvements.

📄 License

MIT — do whatever you want with it.

---

_{Built by Facundo Lucci}