plsreadme

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.

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

- https://plsreadme.com/mcp
- https://plsreadme.com/sse

Those hosted remote MCP routes are live behind OAuth-protected browser login in code, including/authorize,/oauth/token, and/oauth/register.

-

D1doc_create_eventsis the canonical create-attribution table across web, hosted MCP, and local MCP flows.

docs.raw_view_counttracks every render hit, whiledocs.view_countis reserved for likely-human reads.

reconnecting the same client replaces the older grant

signing out of the website does not revoke an existing editor grant by itself

this repo is now wired to a dedicated Cloudflare Workers KV binding namedOAUTH_KV

When browser login is not available in your client, create a personal API key from/my-linksand use either the hosted remote header fallback or the localnpx -y plsreadme-mcppackage.

- anonymous website creates on/api/create-linkrequire a short-lived browser verification grant
- signed-in website creates skip that grant and stay friction-light
- post-create UI now branches intoSave to my account,Connect your editor, andCopy link

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

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

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

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

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

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

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

- access token TTL is about1 hour
- refresh token TTL is about30 days
- reconnecting the same client replaces the older grant
- sign out ends the website session but does not automatically revoke an existing editor grant
- useGET /api/auth/mcp-grantsandDELETE /api/auth/mcp-grants/:grantIdto audit or revoke hosted editor grants

If your client supports browser login, prefer this path. It is the cleanest setup and keeps owned docs tied to your website account automatically.

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

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

If you already usedplsreadme-mcpanonymously:
- Create a personal API key from/my-links.
- AddPLSREADME_API_KEYto your MCP client config.
- KeepPLSREADME_ALLOW_ANONYMOUS=1only as a temporary compatibility crutch for old workflows.
- Claim older anonymous links later with/api/auth/claim-linkif you still have theiradmin_token.

- new automated/editor creates should be owned by default
- anonymous local MCP is now legacy-only and explicit
- the website demo path remains zero-setup even while editor auth gets stricter

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

- 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 therefactor-and-shareprompt to leverage your AI's reasoning for a polished result.

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

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

Built on Cloudflare's edge stack for speed everywhere:

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