用途
plsreadme 用于把 Markdown 文件或普通文本快速变成可分享的网页链接,适合分享 README、PRD、会议记录或 API 文档给没有 Markdown 渲染器或不使用 GitHub 的人。生成的链接可以在浏览器中直接打开。
主要能力
- 即时分享:粘贴 Markdown 或上传文件,获得 plsrd.me 短链接,无需账户或注册。
- 美观渲染:干净的排版、深色模式、移动端响应式。
- 行内评论:读者可以点击任意段落留下反馈。
- 审查模式:多版本文档默认显示当前草稿的反馈,可一键切换到完整时间线历史。
- AI 自动格式化:输入原始文本,可输出干净的 Markdown。
- MCP 服务器:可从 Claude、Cursor、VS Code 或任何 MCP 客户端直接分享文档。
- OpenClaw 技能:在 ClawHub 上可用于 AI 智能体工作流。
- 短链接与原始访问:每个文档获得 plsrd.me/v/xxx 形式的短链接,并可下载原始 .md 文件。
- 版本时间线与安全恢复:提供 /v/:id/versions 和 /v/:id/history 端点,以及归档优先、非破坏性的恢复 API。
- 认证与所有权:集成 Clerk 认证(GitHub/Google 登录、Clerk 托管邮箱回退),可将文档关联到用户(owner_user_id),同时保留匿名流程;提供 My Links 仪表盘(搜索、排序、分页、快速复制/打开);支持通过 admin_token 认领旧匿名链接。
使用方式
网站
直接访问 plsreadme.com,粘贴 Markdown,点击分享即可。无需账户或 API 密钥。
认证路径建议
- 先在浏览器中试用,这是最快的演示路径,无需 MCP 设置。
- 当客户端验证支持时,使用托管远程 MCP 配合浏览器登录。
- 当交互式登录不可用时,使用 API 密钥或本地 MCP 回退。
托管远程 MCP 路由包括 https://plsreadme.com/mcp 和 https://plsreadme.com/sse,受 OAuth 保护,包含 /authorize、/oauth/token 和 /oauth/register。访问令牌约 1 小时有效,刷新令牌约 30 天有效。
当客户端不支持浏览器登录时,可从 /my-links 创建个人 API 密钥,使用托管远程头回退或本地 npx -y plsreadme-mcp 包。
本地 MCP 客户端配置示例:
- Cursor:添加到 ~/.cursor/mcp.json
- VS Code:添加到 .vscode/mcp.json
- Claude Desktop:添加到 claude_desktop_config.json
- Windsurf:添加到 ~/.codeium/windsurf/mcp_config.json
本地 stdio 默认需要 PLSREADME_API_KEY,旧版匿名模式可通过 PLSREADME_ALLOW_ANONYMOUS=1 显式启用。从 https://plsreadme.com/my-links 创建密钥。
MCP 工具包括 share-document(引导分享内容为可读链接)和 refactor-and-share(使用 AI 模型将原始文本重构为润色后的 Markdown 再分享)。
版本管理与 AI 迭代
对于迭代式 AI 写作流程,智能体可以消费 /v/:id/versions 作为事实来源:保留人类可读的 /v/:id 链接;在迭代之间轮询 /v/:id/versions;比较 current_version 与上次审查的版本;若变化则获取 raw_url 运行检查;若质量回退,可选触发 /v/:id/restore(需 admin token 和所有者会话)。恢复操作有速率限制(当前 60 次/小时)。
评论审查
文档查看器暴露评论审查控件:Current draft(仅显示最新版本评论,多版本文档默认)和 Timeline(显示跨版本完整评论历史)。API 中可获取相同模式,查看器链接会在 URL 中保留模式,例如 ?view=current 或 ?view=timeline。
认领旧链接
要将旧匿名链接认领到登录账户,需证明原始 admin_token,使用 /api/auth/claim-link。
技术栈
基于 Cloudflare 边缘栈:Hono(Workers 上的轻量 Web 框架)、Cloudflare D1(边缘 SQLite,用于元数据、评论、分析)、Cloudflare R2(Markdown 文档对象存储)、Durable Objects(有状态 MCP 服务器端点)、Workers AI(可选的文本转 Markdown 回退)。项目使用 MIT 许可证。
适用场景
- 需要快速分享 Markdown 文档但对方不使用 GitHub 或没有渲染器。
- 希望在不注册账户的情况下获得可读链接。
- 在 AI 编辑器(Claude、Cursor、VS Code)中通过 MCP 直接用自然语言分享文档。
- 需要多版本协作评论和版本回滚的写作流程。
限制
- 官方资料未提及具体收费或价格信息。
- 托管远程 MCP 的 OAuth 登录需要客户端支持;否则需使用 API 密钥回退。
- 本地 stdio 匿名模式已标记为旧版,新自动化创建应默认归属用户。
- 访问令牌约 1 小时,刷新令牌约 30 天;登出网站不会自动撤销已有编辑器授权。
- .plsreadme 记录文件包含 admin token,应加入 .gitignore。