Go to app!
⚡ MCP Server

plsreadme MCP Server

Share markdown as clean web links with browser login in supported editors

Recommended path: add the hosted remote server, finish browser login once, and let your editor create account-owned docs. When that flow is unavailable, create a personal API key from /my-links and use either remote headers or the local npx -y plsreadme-mcp package.

Connect Your Editor

Sign in here first if you want the hosted remote MCP flow. Supported clients will open browser login once, then new shares land in your account automatically.

Access tokens last about 1 hour. Refresh tokens last about 30 days. Reconnecting the same editor replaces the older grant. Signing out of the website does not revoke an existing editor grant by itself. If you need the fallback path, mint a personal API key from My Links.

Compatibility Matrix

Current as of April 5, 2026, based on the latest Claude Code, Windsurf, Anthropic connector, Cursor, and VS Code MCP docs.

Remote login supported

Claude Code

Supports remote HTTP MCP and can authenticate remote servers with OAuth from the built-in /mcp flow.

Remote config + headers supported

Cursor

Cursor documents remote MCP configs, per-server headers, and an MCP login flow in Cursor Agent. Use browser login first; fall back to a personal API key if your build does not complete the OAuth prompt.

Remote login supported

Windsurf

Supports remote MCP over Streamable HTTP and SSE, and Windsurf’s docs explicitly note OAuth support for each transport.

Remote login supported

Claude Desktop / Claude web connectors

Anthropic’s connector docs cover remote web connectors and browser OAuth permissions for supported paid plans.

Fallback ready

VS Code / any client without working remote OAuth

Use a personal API key with either remote headers or the local npm MCP package. Legacy anonymous local mode now requires explicit opt-in.

Recommended Remote Setup

Claude Code

Add the hosted MCP endpoint. Claude Code opens browser login on first authenticated use.

Run in your terminal:
claude mcp add --transport http plsreadme https://plsreadme.com/mcp

Cursor / generic remote MCP JSON

Use the hosted URL directly. On first connect, the client should open the browser authorization flow.

Remote MCP JSON:
{
  "mcpServers": {
    "plsreadme": {
      "url": "https://plsreadme.com/mcp"
    }
  }
}

VS Code

Use the remote MCP URL in your workspace or user-level MCP configuration. If your build does not offer browser auth yet, use the API key fallback below.

.vscode/mcp.json
{
  "servers": {
    "plsreadme": {
      "type": "http",
      "url": "https://plsreadme.com/mcp"
    }
  }
}

Windsurf

Point the remote MCP config at the hosted URL. Windsurf’s MCP docs support OAuth on remote transports.

~/.codeium/windsurf/mcp_config.json
{
  "mcpServers": {
    "plsreadme": {
      "serverUrl": "https://plsreadme.com/mcp"
    }
  }
}
If your client does not open the browser prompt, create a personal API key from My Links and use the remote header or local stdio fallback below.

Local npm Fallback

Step 1: sign in and create a personal API key from My Links. Step 2: paste one of these configs. The local package now expects PLSREADME_API_KEY by default.

Need the old anonymous behavior for a one-off workflow? Opt in explicitly with PLSREADME_ALLOW_ANONYMOUS=1.

~/.cursor/mcp.json
{
  "mcpServers": {
    "plsreadme": {
      "command": "npx",
      "args": ["-y", "plsreadme-mcp"],
      "env": {
        "PLSREADME_API_KEY": "${env:PLSREADME_API_KEY}"
      }
    }
  }
}
claude_desktop_config.json
{
  "mcpServers": {
    "plsreadme": {
      "command": "npx",
      "args": ["-y", "plsreadme-mcp"],
      "env": {
        "PLSREADME_API_KEY": "<paste-your-personal-api-key>"
      }
    }
  }
}
.vscode/mcp.json
{
  "inputs": [
    {
      "type": "promptString",
      "id": "plsreadme-api-key",
      "description": "plsreadme personal API key",
      "password": true
    }
  ],
  "servers": {
    "plsreadme": {
      "command": "npx",
      "args": ["-y", "plsreadme-mcp"],
      "env": {
        "PLSREADME_API_KEY": "${input:plsreadme-api-key}"
      }
    }
  }
}
~/.codeium/windsurf/mcp_config.json
{
  "mcpServers": {
    "plsreadme": {
      "command": "npx",
      "args": ["-y", "plsreadme-mcp"],
      "env": {
        "PLSREADME_API_KEY": "${env:PLSREADME_API_KEY}"
      }
    }
  }
}
Run in your terminal:
claude mcp add --transport stdio \
  --env PLSREADME_API_KEY=$PLSREADME_API_KEY \
  plsreadme -- npx -y plsreadme-mcp
Remote API key fallback (generic HTTP headers):
{
  "mcpServers": {
    "plsreadme-api": {
      "url": "https://plsreadme.com/mcp",
      "headers": {
        "Authorization": "Bearer ${env:PLSREADME_API_KEY}"
      }
    }
  }
}
Auto-detects your editor after you export PLSREADME_API_KEY:
npx add-mcp plsreadme-mcp

Tools

plsreadme_share_file

Reads a local markdown file and generates a shareable link

plsreadme_share_text

Takes markdown text and generates a shareable link

Use Cases

📄 Share README.md as a clean link for stakeholders

📋 Generate preview links for PRDs, proposals, API docs

📝 Share markdown notes without setting up a website

💬 Create shareable documentation from any AI chat

Example Prompts

"Share this README on plsreadme" "Generate a preview link for docs/api.md" "Create a shareable link for this PRD"