# FacundoLucci/plsreadme [Health: Active]

**Category:** 📂 File Systems  
**Repository:** https://github.com/FacundoLucci/plsreadme  
**GitHub Stars:** 4  
**npm Downloads (last month):** 73  
**Views:** 3  
**Installs:** 0  
**Upvotes:** 0  
**Directory Page:** https://allmcps.com/mcp/facundolucci-plsreadme

## Description
Share markdown files and text as clean, readable web links via plsreadmesharefile and plsreadmesharetext; zero setup (npx -y plsreadme-mcp or https://plsreadme.com/mcp).

## Tools
Capabilities this server exposes over MCP:

- **plsreadme_share_file** — Share a local markdown file as a clean, readable web link on plsreadme.com.

Reads the file, uploads it, and returns a permanent shareable URL. If the file was previously shared, updates the existing link instead of creating a new one.

Tracks links in a local .plsreadme file for future edits and deletes.
- **plsreadme_share_text** — Share text as a clean, readable web link on plsreadme.com.

Accepts markdown or plain text. Plain text is auto-structured into markdown before upload. Returns a permanent shareable URL.

Tracks links in a local .plsreadme file for future edits and deletes.
- **plsreadme_update** — Update an existing plsreadme document with new content.

Requires either the document ID or the original file path. Looks up the admin token from the local .plsreadme record file.
- **plsreadme_delete** — Delete a plsreadme document permanently.

Requires either the document ID or the original file path. Looks up the admin token from the local .plsreadme record file.
- **plsreadme_list** — List all plsreadme documents tracked in the local .plsreadme file.

Shows document IDs, titles, URLs, and source files.

## Claude Desktop Quick Installation
Install path detected from listing signals. Uses `npx` (confidence: high):

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

**Requires environment variables:** `PLSREADME_API_KEY` — the values above are empty placeholders; fill in real credentials before running (see the repository for what each one is for).

## Documentation

## What FacundoLucci/plsreadme MCP server does

FacundoLucci/plsreadme MCP server exposes document-sharing and document-management tools through MCP. It works with local Markdown files and text supplied directly in a conversation, sending the content to plsreadme.com and returning a shareable web URL.

The resulting pages are intended for readers who may not use GitHub or have a Markdown renderer. The service also provides rendered views, raw Markdown access, compact links, and browser-based viewing. The supplied material describes inline comments, version timelines, and review modes as features of the hosted document experience.

## How it works

The `plsreadme_share_file` tool reads a local Markdown file and uploads it. When the same file has already been shared, the tool can update the existing document rather than create another link. The `plsreadme_share_text` tool accepts Markdown or plain text; plain text is automatically structured into Markdown before upload.

After sharing, the server records link information in a local `.plsreadme` file. That record supports later edits and deletions. The list tool reads the record and reports document IDs, titles, URLs, and source files.

Updates and deletions can identify a document by its ID or by its original file path. The server uses the corresponding administrative token stored in the `.plsreadme` record. At the API level, updates and deletes use an authorization token; authenticated documents may also require the owning user session.

## Setup and configuration

The package can be run locally with the npm command `npx -y plsreadme-mcp`. The README also provides a hosted MCP endpoint at `https://plsreadme.com/mcp` and an SSE endpoint at `https://plsreadme.com/sse`.

The current deployment supports browser-based login for hosted remote MCP in compatible clients. A personal API key is the fallback when interactive login is unavailable, and the local npm MCP path is documented with `PLSREADME_API_KEY`. Anonymous local use remains available only with explicit opt-in. The browser demo itself does not require an account or API key.

## Tools and capabilities

FacundoLucci/plsreadme MCP server provides these tools:

- `plsreadme_share_file`: Upload a local Markdown file and return its web link, reusing the tracked document when appropriate.
- `plsreadme_share_text`: Publish Markdown or plain text, with automatic formatting for plain-text input.
- `plsreadme_update`: Replace the contents of an existing document using its ID or original path.
- `plsreadme_delete`: Permanently remove an existing document using its ID or original path.
- `plsreadme_list`: Show documents recorded in the local `.plsreadme` file.

The hosted service maintains document versions and supports non-destructive restoration of an earlier version through its API. Shared pages can expose current-draft comments or the full comment timeline. These features are relevant when a document is being reviewed or repeatedly revised, although the listed MCP tools focus on sharing and document administration.

Use this server when the output needs to be a link that can open in a normal browser. It is less suited to workflows that require a private, self-hosted renderer or storage system, because the documented sharing flow uploads content to plsreadme.com.

_Full upstream README: https://allmcps.com/mcp/facundolucci-plsreadme/readme_