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.
LABSCO SUMMARY
Markdown to a shareable URL in one call, and the same call again to update it.
The five tools cover the whole life of a document — publish, update, delete, list — and re-sharing a file path lands on the existing link rather than scattering new ones, so the URL you already sent stays correct. Editing rights travel with a local .plsreadme file, which means the machine that published a document is the machine that can change it.
What it is
A publishing server for markdown. It takes a local .md file or raw text, uploads it to plsreadme.com, and hands back a permanent URL that renders in any browser.
What you get
- Share a local markdown file by path — re-sharing the same file updates the existing link instead of creating a second one
- Share text directly; plain text is auto-structured into markdown before upload
- Update a published document by document ID or by the original file path
- Delete a published document permanently
- List everything you have shared, with document IDs, titles, URLs and source files
Requirements
A plsreadme account for owned documents. Two ways in: the hosted endpoint https://plsreadme.com/mcp over HTTP, where the first authenticated call opens browser login; or local stdio with npx -y plsreadme-mcp. Clients that cannot complete browser login send a personal key instead — create it at /my-links and pass PLSREADME_API_KEY for stdio or an Authorization: Bearer header for HTTP. Local stdio expects PLSREADME_API_KEY by default; PLSREADME_ALLOW_ANONYMOUS=1 restores the older anonymous mode. Edits are keyed to a local .plsreadme record file, which stores the admin token per document.
Setup effort
One command plus a key — npx -y plsreadme-mcp, then supply credentials
USE CASES
01
Sending a spec to someone who does not open GitHub
Share the local markdown file by path and hand over the URL that comes back.
02
Keeping one link current while the draft keeps changing
Update by the original file path after each revision, so the address you already circulated keeps resolving to the latest text.
03
Publishing notes that were never saved to a file
Pass the text straight through — plain text is structured into markdown before it is uploaded.
04
Working out what you have already published
List the tracked documents with their IDs, titles, URLs and source files.
05
Taking down something you shared by mistake
Delete it by document ID or by the original file path.
5 tools
Counted once with only startup setup. Other versions, modes or optional credentials may expose a different list.
plsreadme_list
List all plsreadme documents tracked in the local .plsreadme file.
Shows document IDs, titles, URLs, and source files.
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.
BEFORE YOU INSTALL
What to know first
Tools you get
5 tools when we connected.
Requires
- npx on PATH
- PLSREADME_API_KEY in your environment
CONTEXT COST
Light Standing cost
Rated by the size of the 5 tool definitions that ride along on every turn, not by how many there are
INSTALLATION
Connect your client
Server setup
npx
TERMINAL
npx -y plsreadme-mcpHosted endpoint
ENDPOINT URL
https://plsreadme.com/mcpAdd this hosted endpoint to your MCP client using the credentials listed under Requirements.
MCP Clients
Claude Code
CLAUDE CODE · TERMINAL
claude mcp add --transport http plsreadme https://plsreadme.com/mcpCursor
CURSOR · JSON
{
"mcpServers": {
"plsreadme": {
"url": "https://plsreadme.com/mcp"
}
}
}VS Code
VS CODE · JSON
{
"servers": {
"plsreadme": {
"type": "http",
"url": "https://plsreadme.com/mcp"
}
}
}Windsurf
WINDSURF · JSON
{
"mcpServers": {
"plsreadme": {
"serverUrl": "https://plsreadme.com/mcp"
}
}
}Claude Desktop
CLAUDE DESKTOP · JSON
{
"mcpServers": {
"plsreadme": {
"command": "npx",
"args": [
"-y",
"plsreadme-mcp"
],
"env": {
"PLSREADME_API_KEY": "<YOUR_PLSREADME_API_KEY>"
}
}
}
}Any MCP client — add-mcp
ANY MCP CLIENT — ADD-MCP · TERMINAL
npx add-mcp plsreadme-mcpOpenClaw
OPENCLAW · TERMINAL
clawhub install plsreadmeOther routes
Raw HTTP (curl)
RAW HTTP (CURL) · TERMINAL
curl -i https://plsreadme.com/mcp \
-H "Authorization: Bearer $PLSREADME_API_KEY"
