Plsreadme

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.