plsreadme

通过 plsreadme.com 将 Markdown 文件和文本共享为干净、可读的 Web 链接。当有人要求共享文档、README、PRD、提案、注释或任何 Markdown 作为可共享链接时使用。还会触发“创建预览链接”、“将其共享为页面”或“使其可读”。需要 plsreadme MCP 服务器 (npx plsreadme-mcp)。

# plsreadme

Share markdown as clean `plsrd.me` links. Two tools available via MCP:

## Setup

Add the MCP server to your client:

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

Or use the remote endpoint (zero install):

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

## Tools

- **`plsreadme_share_file`** — Share a local `.md` file by path. Reads from disk, uploads, returns link.
- **`plsreadme_share_text`** — Share text directly (markdown preferred; plain text supported). Good for generated content, conversation output, or composed docs.

## Usage Guidelines

- Max file size: 200KB
- Links are permanent and publicly accessible — confirm with the user before sharing sensitive content
- If input is non-markdown, refactor it with your own model first (or let `plsreadme_share_text` auto-structure plain text)
- The first `# Heading` becomes the document title
- Output includes a readable URL and a raw markdown URL

## Example Prompts

- "Share this README on plsreadme"
- "Create a shareable link for docs/api.md"
- "Turn this into a readable web page I can send"
- "Share this PRD as a link"

---

## 中文说明

# plsreadme

将 Markdown 共享为干净的 `plsrd.me` 链接。通过 MCP 提供两个工具：

## 设置

将 MCP 服务器添加到你的客户端：

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

或使用远程端点（零安装）：

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

## 工具

- **`plsreadme_share_file`** —— 通过路径共享本地 `.md` 文件。从磁盘读取，上传，返回链接。
- **`plsreadme_share_text`** —— 直接共享文本（推荐 Markdown；也支持纯文本）。适合生成的内容、会话输出或拼装好的文档。

## 使用指南

- 最大文件大小：200KB
- 链接是永久且可公开访问的 —— 在共享敏感内容前请与用户确认
- 如果输入不是 Markdown，先用你自己的模型重新整理（或让 `plsreadme_share_text` 自动结构化纯文本）
- 第一个 `# Heading` 会成为文档标题
- 输出中包含一个可读 URL 和一个原始 Markdown URL

## 示例提示词

- "Share this README on plsreadme"
- "Create a shareable link for docs/api.md"
- "Turn this into a readable web page I can send"
- "Share this PRD as a link"