SuperAPI AI Directory
Partner with us中文AI newsFavorites
All toolsAI developer platformsplsreadme

plsreadme

Share Markdown files and text as readable web links.

Open website

About this tool

Purpose

plsreadme is used to quickly turn Markdown files or plain text into shareable web links, suitable for sharing READMEs, PRDs, meeting notes, or API docs with people who do not have a Markdown renderer or do not use GitHub. The generated link can be opened directly in a browser.

Main capabilities

  • Instant sharing: paste Markdown or upload a file to get a plsrd.me short link, with no account or registration required.
  • Beautiful rendering: clean typography, dark mode, mobile responsive.
  • Inline comments: readers can click any paragraph to leave feedback.
  • Review mode: multi-version documents show feedback for the current draft by default, with one-click switching to the full timeline history.
  • AI auto-formatting: input raw text and output clean Markdown.
  • MCP server: share documents directly from Claude, Cursor, VS Code, or any MCP client.
  • OpenClaw skill: available on ClawHub for AI agent workflows.
  • Short links and raw access: each document gets a short link in the form plsrd.me/v/xxx, and the original .md file can be downloaded.
  • Version timeline and safe recovery: provides /v/:id/versions and /v/:id/history endpoints, as well as an archive-first, non-destructive recovery API.
  • Authentication and ownership: integrates Clerk authentication (GitHub/Google login, Clerk-hosted email fallback), can associate documents with users (owner_user_id), while preserving the anonymous flow; provides a My Links dashboard (search, sort, pagination, quick copy/open); supports claiming old anonymous links via admin_token.

How to use

Website

Go directly to plsreadme.com, paste Markdown, and click share. No account or API key required.

Suggested authentication paths

  1. Try it in the browser first; this is the fastest demo path and requires no MCP setup.
  2. When client validation supports it, use hosted remote MCP with browser login.
  3. When interactive login is unavailable, use an API key or the local MCP fallback.

Hosted remote MCP routes include https://plsreadme.com/mcp and https://plsreadme.com/sse，受 OAuth protection, including /authorize, /oauth/token, and /oauth/register. Access tokens are valid for about 1 hour, and refresh tokens are valid for about 30 days.

When the client does not support browser login, you can create a personal API key from /my-links, use the hosted remote header fallback, or use the local npx -y plsreadme-mcp package.

Example local MCP client configuration:

  • Cursor: add to ~/.cursor/mcp.json
  • VS Code: add to .vscode/mcp.json
  • Claude Desktop: add to claude_desktop_config.json
  • Windsurf: add to ~/.codeium/windsurf/mcp_config.json

Local stdio requires PLSREADME_API_KEY by default; legacy anonymous mode can be explicitly enabled with PLSREADME_ALLOW_ANONYMOUS=1. From https://plsreadme.com/my-links Create a key.

MCP tools include share-document (guides sharing content as a readable link) and refactor-and-share (uses an AI model to refactor raw text into polished Markdown before sharing).

Version Management and AI Iteration

For iterative AI writing workflows, agents can consume /v/:id/versions as the source of truth: keep the human-readable /v/:id link; poll /v/:id/versions between iterations; compare current_version with the last reviewed version; if changed, fetch raw_url to run checks; if quality regresses, optionally trigger /v/:id/restore (requires admin token and owner session). Restore operations are rate-limited (currently 60 times/hour).

Comment Review

The document viewer exposes comment review controls: Current draft (shows only comments on the latest version, the default for multi-version documents) and Timeline (shows the full comment history across versions). The same modes are available in the API, and viewer links preserve the mode in the URL, for example ?view=current or ?view=timeline.

Claiming Old Links

To claim an old anonymous link to a logged-in account, you must prove the original admin_token, using /api/auth/claim-link.

Tech Stack

Built on the Cloudflare edge stack: Hono (a lightweight web framework on Workers), Cloudflare D1 (edge SQLite, used for metadata, comments, analytics), Cloudflare R2 (Markdown document object storage), Durable Objects (stateful MCP server endpoints), Workers AI (optional text-to-Markdown fallback). The project uses the MIT license.

Use Cases

  • Need to quickly share a Markdown document but the other party does not use GitHub or does not have a renderer.
  • Want a readable link without registering an account.
  • Share documents directly in natural language via MCP in AI editors (Claude, Cursor, VS Code).
  • Writing workflows that require multi-version collaborative comments and version rollback.

Limitations

  • Official materials do notmention specific fees or pricing information.
  • OAuth login for hosted remote MCP requires client support; otherwise, an API key fallback must be used.
  • Local stdio anonymous mode is marked as legacy; new automated creations should be attributed to a user by default.
  • Access tokens last about 1 hour, refresh tokens about 30 days; logging out of the website does not automatically revoke existing editor authorizations.
  • The .plsreadme record file contains the admin token and should be added to .gitignore.

Related tools

Browse category