Log inSubmit server
Plsreadme logo

Plsreadme

by FacundoLucci

Shares Markdown files and text as readable web links, with tools for updating, deleting, and tracking shared documents.

InstallRepositoryWebsite
Full README Compare alternatives Embed widget Claim this listing

Install Plsreadme

Pick your client, then add it in one click or paste the config.

STDIONode.js
~/Library/Application Support/Claude/claude_desktop_config.json
claude_desktop_config.json
{
  "mcpServers": {
    "facundolucci-plsreadme": {
      "command": "npx",
      "args": [
        "-y",
        "plsreadme-mcp"
      ],
      "env": {
        "PLSREADME_API_KEY": "YOUR_VALUE_HERE"
      }
    }
  }
}

Settings → Developer → Edit Config, merge this into mcpServers, then fully quit and reopen Claude Desktop.

Values are written into the snippet above so you can paste it as is. They never leave your browser.

Automated check passed— started and listed 5 tools correctly (1mo ago).

Overview

FacundoLucci/plsreadme MCP server shares local Markdown files and text as readable web links on plsreadme.com. It uploads file contents or converts plain text into Markdown, then returns a permanent URL while recording document details in a local .plsreadme file. Additional tools update, delete, or list tracked documents using their IDs or source paths. Reach for it when an AI editor needs to publish READMEs, PRDs, meeting notes, or other text as browser-friendly pages.

Use cases

  • Share a README as a browser-readable link
  • Publish a PRD for review
  • Convert meeting notes into a formatted page
  • Update an existing shared Markdown document
  • List and manage tracked document links

Key features

  • Share local Markdown files
  • Share Markdown or plain text
  • Auto-format plain text as Markdown
  • Track documents in a local .plsreadme file
  • Update and delete shared documents
  • List document IDs, URLs, titles, and source files

Tools5

What Plsreadme lets your agent do. Expand a tool for its parameters.

Verified live~602 tokens of context

Security & health

What it can reach and how reliably it runs — from our own checks, not the maintainer’s claims.

ActiveLast checked 2d ago

Recent health check succeeded.

18/18 checks healthy over the last 78d

Supply-chain signal

No high-severity advisories surfaced by our automated scan.

Critical 0High 0Medium 0Low 0

Scanned 9d ago via OSV.dev · plsreadme-mcp (npm)

Adoption & maintenance

Factual signals from GitHub, npm, and our automated checks — not a rating.

GitHub stars4Stargazers on the source repository.
npm downloads53Package downloads in the last 30 days.
Last commit2mo agoMost recent push to the default branch.
Availability100%Our rolling endpoint + install checks that succeeded.
Install checkPassedOur sandbox started it and listed its tools.
Tools exposed5Callable tools this server registers over MCP.
Directory activity4 viewsConfig copies, upvotes, and views on AllMCPs.

How Plsreadme works

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.

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.

Read the full README View source on GitHub

Reviews

No reviews yet — be the first to share how it worked for you.

Frequently Asked Questions about Plsreadme

Run `npx -y plsreadme-mcp` for the local npm MCP server, or configure a client to use the hosted endpoint at `https://plsreadme.com/mcp`.

Yes. The `plsreadme_share_text` tool accepts plain text and automatically structures it as Markdown before uploading it.

Use `plsreadme_update` with the document ID or original file path. The server looks up the administrative token in the local `.plsreadme` record.

Yes.

Related MCP servers

All in File Systems All alternatives
Add a badge to your READMEShow it’s listed — live SVG, Markdown or HTML.

AllMCPs Directory Badge

Full Badge Customizer

Showcase your server listing on GitHub or your project documentation. Embed this dynamic SVG badge to highlight official listing status and live engagement.

Badge Style:
Live Dynamic SVG PreviewPlsreadme AllMCPs Directory Badge
Markdown (GitHub README)
[![AllMCPs](https://allmcps.com/api/badge/facundolucci-plsreadme?style=directory)](https://allmcps.com/mcp/facundolucci-plsreadme)
HTML Embed
<a href="https://allmcps.com/mcp/facundolucci-plsreadme"><img src="https://allmcps.com/api/badge/facundolucci-plsreadme?style=directory" alt="Plsreadme on AllMCPs" /></a>