de en es ja ko ru zh

plsreadme

Name: plsreadme
Author: FacundoLucci

by FacundoLucci

Overview Schema Source Related Servers Discussions Admin

TypeScript

문제점

마크다운으로 README, PRD, 회의록 또는 API 문서를 작성했습니다. 이제 마크다운 렌더러가 없거나, GitHub를 사용하지 않거나, 브라우저에서 열 수 있는 깔끔한 링크가 필요한 사람과 공유해야 합니다.

plsreadme는 어떤 마크다운이든 한 번의 단계로 영구적이고 아름답게 렌더링된 웹 페이지로 변환합니다. 계정이나 가입이 필요 없으며, 번거로움도 없습니다.

Related MCP server: slideless-mcp

✨ 주요 기능

즉시 공유 — 마크다운을 붙여넣거나 파일을 업로드하면 plsrd.me 링크를 받을 수 있습니다.
아름다운 렌더링 — 깔끔한 타이포그래피, 다크 모드, 모바일 반응형 지원
인라인 댓글 — 독자가 단락을 클릭하여 피드백을 남길 수 있습니다.
검토 모드 (현재 vs 타임라인) — 다중 버전 문서는 기본적으로 현재 초안 피드백을 보여주며, 클릭 한 번으로 전체 타임라인 기록에 접근할 수 있습니다.
AI 자동 서식 지정 — 원시 텍스트를 입력하면 깔끔한 마크다운으로 변환됩니다.
MCP 서버 — Claude, Cursor, VS Code 또는 모든 MCP 클라이언트에서 직접 문서를 공유하세요.
OpenClaw 스킬 — AI 에이전트 워크플로우를 위해 ClawHub에서 사용할 수 있습니다.
단축 링크 — 모든 문서는 간결한 plsrd.me/v/xxx URL을 가집니다.
원본 접근 — 공유된 링크에서 원본 .md 파일을 다운로드할 수 있습니다.
버전 타임라인 + 안전한 복원 — /v/:id/versions + /v/:id/history + 빠른 롤백을 위한 아카이브 우선 복원 API
Clerk 인증 기반 — GitHub/Google 로그인 연동 + Clerk 호스팅 이메일 폴백 + 백엔드 인증 확인 유틸리티
소유권 모델 (2단계) — 익명 흐름을 유지하면서 문서를 Clerk 사용자(owner_user_id)에게 연결할 수 있습니다.
내 링크 대시보드 (3단계) — 검색/정렬/페이지 매김 및 빠른 복사/열기 작업이 가능한 인증된 /my-links 페이지
레거시 링크 소유권 주장 (4단계) — 로그인한 사용자는 원본 admin_token을 증명하여 이전 익명 링크의 소유권을 주장할 수 있습니다.
제로 구성 웹사이트 데모 — 브라우저에서 사용해 보기 위해 계정이나 API 키가 필요하지 않습니다.

🚀 빠른 시작

웹

plsreadme.com에 접속하여 마크다운을 붙여넣고 공유를 클릭하세요.

인증 경로 및 출시 상태

권장 순서:

브라우저에서 먼저 시도 — 가장 빠른 데모 경로, MCP 설정 불필요.
클라이언트 지원이 확인되면 브라우저 로그인이 포함된 호스팅 원격 MCP 사용.
대화형 로그인을 사용할 수 없는 경우 API 키 / 로컬 MCP 폴백 사용.

현재 출시 상태:

여정	현재 상태	소유권 규칙	소스 태그
익명 웹사이트 데모	브라우저 검증 데모 흐름을 통해 즉시 사용 가능	사용자가 나중에 문서를 저장/주장하기 전까지 `owner_user_id = NULL`	`web_demo`
로그인한 웹사이트 생성	즉시 사용 가능	로그인한 Clerk 사용자를 소유자로 하여 문서 생성	`web_signed_in`
브라우저 로그인이 포함된 호스팅 원격 MCP	지원되는 클라이언트에서 즉시 사용 가능	브라우저 로그인 후 로그인한 사용자를 위한 소유 문서 생성	`mcp_remote_login`
API 키가 포함된 호스팅 원격 MCP	호환성 폴백으로 즉시 사용 가능	API 키 소유자를 위한 소유 문서 생성	`mcp_remote_api_key`
API 키가 포함된 로컬 npm MCP	로컬 stdio 설정에 권장되며 즉시 사용 가능	API 키 소유자를 위한 소유 문서 생성	`mcp_local_api_key`
로컬 npm MCP 익명 폴백	명시적 선택 시에만 사용 가능	나중에 주장/저장되지 않는 한 익명으로 유지	`mcp_local_anonymous`

호스팅 원격 MCP 출시 참고 사항:

https://plsreadme.com/mcp
https://plsreadme.com/sse

해당 호스팅 원격 MCP 경로는 /authorize, /oauth/token, /oauth/register를 포함하여 코드 내 OAuth 보호 브라우저 로그인 뒤에서 라이브 상태입니다.

운영 참고 사항:

D1 doc_create_events는 웹, 호스팅 MCP 및 로컬 MCP 흐름 전반에 걸친 표준 생성 속성 테이블입니다.
docs.raw_view_count는 모든 렌더링 히트를 추적하며, docs.view_count는 사람이 읽은 것으로 추정되는 조회수 전용입니다.
프로덕션 쿼리 세트 및 대응 단계는 docs/runbooks/auth-surface-monitoring.md를 참조하세요.
액세스 토큰은 약 1시간 동안 지속됩니다.
리프레시 토큰은 약 30일 동안 지속됩니다.
동일한 클라이언트를 다시 연결하면 이전 권한이 대체됩니다.
웹사이트에서 로그아웃해도 기존 편집자 권한이 자동으로 취소되지는 않습니다.
이 저장소는 이제 OAUTH_KV라는 전용 Cloudflare Workers KV 바인딩에 연결되어 있습니다.

클라이언트에서 브라우저 로그인을 사용할 수 없는 경우, /my-links에서 개인 API 키를 생성하고 호스팅 원격 헤더 폴백 또는 로컬 npx -y plsreadme-mcp 패키지를 사용하세요.

현재 웹사이트 데모 신뢰 모델:

/api/create-link에서 생성되는 익명 웹사이트는 단기 브라우저 검증 권한이 필요합니다.
로그인한 웹사이트 생성은 해당 권한을 건너뛰며 마찰이 적습니다.
생성 후 UI는 이제 내 계정에 저장, 편집기 연결, 링크 복사로 분기됩니다.

API

curl -X POST https://plsreadme.com/api/render \
  -H "Content-Type: application/json" \
  -d '{"markdown": "# Hello World\n\nThis is my doc."}'

{
  "id": "abc123def456",
  "url": "https://plsreadme.com/v/abc123def456",
  "raw_url": "https://plsreadme.com/v/abc123def456/raw",
  "admin_token": "sk_..."
}

admin_token을 저장하세요. 편집하거나 삭제할 때 필요합니다:

# Update
curl -X PUT https://plsreadme.com/v/abc123def456 \
  -H "Authorization: Bearer sk_..." \
  -H "Content-Type: application/json" \
  -d '{"markdown": "# Updated content"}'

# Delete
curl -X DELETE https://plsreadme.com/v/abc123def456 \
  -H "Authorization: Bearer sk_..."

버전 타임라인 + 안전한 복원

AI 반복 주기 동안 수정 컨텍스트를 검토하려면 타임라인 엔드포인트를 사용하세요:

curl https://plsreadme.com/v/abc123def456/versions

{
  "id": "abc123def456",
  "current_version": 5,
  "total_versions": 5,
  "versions": [
    { "version": 5, "is_current": true, "raw_url": "https://plsreadme.com/v/abc123def456/raw" },
    { "version": 4, "is_current": false, "raw_url": "https://plsreadme.com/v/abc123def456/raw?version=4" }
  ]
}

AI 편집으로 인해 문서가 퇴보하면 이전 스냅샷을 복원하세요 (아카이브 우선, 비파괴적):

curl -X POST https://plsreadme.com/v/abc123def456/restore \
  -H "Authorization: Bearer sk_..." \
  -H "Content-Type: application/json" \
  -d '{"version": 4}'

복원은 남용을 줄이기 위해 업데이트와 유사하게 속도 제한이 적용됩니다 (현재 액터 키당 60회/시간).

인증된 Clerk 사용자가 소유한 문서의 경우, 업데이트/삭제/복원 시에도 해당 소유자 세션이 필요합니다(사용자 간 변조 방지). 반면 익명 문서는 admin_token만으로 계속 작동합니다.

검토 모드 사용 참고 사항 (현재 초안 우선, 타임라인 요청 시)

문서 뷰어는 이제 댓글 검토 제어 기능을 노출합니다:

현재 초안 — 최신 문서 버전에 연결된 댓글만 표시합니다 (문서에 여러 버전이 있을 때 기본값).
타임라인 — 전체 버전 간 댓글 기록을 표시합니다.

API에서 직접 동일한 모드를 가져올 수 있습니다:

# Latest-version comments only
curl "https://plsreadme.com/api/comments/abc123def456?view=current"

# Full timeline comments (default API behavior)
curl "https://plsreadme.com/api/comments/abc123def456?view=all"

뷰어 링크는 공유 가능한 검토 컨텍스트를 위해 URL에 모드를 유지합니다:

https://plsreadme.com/v/abc123def456?view=current
https://plsreadme.com/v/abc123def456?view=timeline

레거시 익명 링크를 로그인한 계정으로 가져오려면:

curl -X POST https://plsreadme.com/api/auth/claim-link \
  -H "Authorization: Bearer <clerk-session-jwt>" \
  -H "Content-Type: application/json" \
  -d '{"id":"abc123def456","adminToken":"sk_..."}'

MCP (AI 편집기)

현재 권장 사항:

클라이언트가 깔끔하게 지원하는 경우 브라우저 로그인이 포함된 호스팅 원격 MCP를 사용하세요.
해당 클라이언트에서 원격 인증을 사용할 수 없거나 불편한 경우 개인 API 키 폴백을 사용하세요.
가장 안전한 stdio 경로를 위해 PLSREADME_API_KEY와 함께 로컬 plsreadme-mcp 패키지를 사용하세요.

편집기를 plsreadme에 연결하고 자연어로 문서를 공유하세요:

*"이 README를 plsreadme 링크로 공유해줘" *"내 PRD를 공유 가능한 페이지로 바꿔줘" "이 회의록을 읽기 쉬운 링크로 만들어줘"

`/versions`를 사용한 MCP/에이전트 자동 검토 루프

반복적인 AI 작성 흐름(초안 → 비평 → 수정)의 경우, 에이전트는 /v/:id/versions를 진실의 원천으로 사용할 수 있습니다:

사람을 위해 표준 읽기 가능한 URL(/v/:id)을 유지하세요.
반복 주기 사이에 /v/:id/versions를 폴링하세요.
current_version을 마지막으로 검토된 버전과 비교하세요.
변경된 경우 최신 버전에 대한 raw_url을 가져와 검토 확인을 실행하세요.
품질이 퇴보하면 관리자 토큰 + 소유자 세션으로 /v/:id/restore를 선택적으로 트리거하세요.

이렇게 하면 HTML을 스크래핑하지 않고도 자동화된 결정론적 수정 추적이 가능합니다.

전체 플레이북은 docs/ai-iteration-versioning.md를 참조하세요.

🔌 MCP 설정

클라이언트 호환성 매트릭스

2026년 4월 5일 기준:

클라이언트	권장 경로	브라우저 로그인 지원	API 키 폴백	참고 사항
Claude Code	호스팅 원격 MCP 우선	라이브 검증됨	예	가장 잘 지원되는 원격 흐름; `PLSREADME_API_KEY`를 사용한 로컬 stdio도 잘 작동함
Cursor	호스팅 원격 MCP 우선	문서화되어 있으나 실제로는 빌드에 따라 다름	예	빌드에서 OAuth 프롬프트가 나타나지 않으면 헤더를 사용하세요
VS Code	호스팅 원격 MCP (사용 가능한 경우)	구성 존재, 빌드별로 출시 상태 다름	예	로그인 UX가 없을 때 `type: "http"`와 헤더 폴백이 작동함
Windsurf	호스팅 원격 MCP (사용 가능한 경우)	문서화된 원격 지원	예	브라우저 인증이 아직 노출되지 않은 경우 `serverUrl` + 헤더를 사용하세요
Claude Desktop	로컬 npm MCP	검증된 원격 브라우저 흐름 없음	예	stdio + `PLSREADME_API_KEY`를 선호함
Raw HTTP / 스크립트	호스팅 원격 헤더 모드	아니요	예	`Authorization: Bearer $PLSREADME_API_KEY`를 직접 전송하세요

호스팅 원격 로그인 (지원되는 클라이언트)

Claude Code:

claude mcp add --transport http plsreadme https://plsreadme.com/mcp

Cursor:

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

VS Code:

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

Windsurf:

{
  "mcpServers": {
    "plsreadme": {
      "serverUrl": "https://plsreadme.com/mcp"
    }
  }
}

수명 주기 참고 사항:

액세스 토큰 TTL은 약 1시간입니다.
리프레시 토큰 TTL은 약 30일입니다.
동일한 클라이언트를 다시 연결하면 이전 권한이 대체됩니다.
로그아웃하면 웹사이트 세션은 종료되지만 기존 편집자 권한이 자동으로 취소되지는 않습니다.
호스팅 편집자 권한을 감사하거나 취소하려면 GET /api/auth/mcp-grants 및 DELETE /api/auth/mcp-grants/:grantId를 사용하세요.

클라이언트가 브라우저 로그인을 지원하는 경우 이 경로를 선호하세요. 가장 깔끔한 설정이며 소유한 문서를 웹사이트 계정에 자동으로 연결된 상태로 유지합니다.

호스팅 원격 API 키 폴백

먼저 https://plsreadme.com/my-links에서 개인 API 키를 생성한 다음 다음 중 하나를 사용하세요:

Claude Code:

claude mcp add --transport http \
  --header "Authorization: Bearer $PLSREADME_API_KEY" \
  plsreadme-api https://plsreadme.com/mcp

Cursor:

{
  "mcpServers": {
    "plsreadme-api": {
      "url": "https://plsreadme.com/mcp",
      "headers": {
        "Authorization": "Bearer ${env:PLSREADME_API_KEY}"
      }
    }
  }
}

VS Code:

{
  "inputs": [
    {
      "type": "promptString",
      "id": "plsreadme-api-key",
      "description": "plsreadme personal API key",
      "password": true
    }
  ],
  "servers": {
    "plsreadme-api": {
      "type": "http",
      "url": "https://plsreadme.com/mcp",
      "headers": {
        "Authorization": "Bearer ${input:plsreadme-api-key}"
      }
    }
  }
}

Windsurf:

{
  "mcpServers": {
    "plsreadme-api": {
      "serverUrl": "https://plsreadme.com/mcp",
      "headers": {
        "Authorization": "Bearer ${env:PLSREADME_API_KEY}"
      }
    }
  }
}

원시 원격 엔드포인트 사용자:

curl -i https://plsreadme.com/mcp \
  -H "Authorization: Bearer $PLSREADME_API_KEY"

로컬 npm 폴백

Claude Code:

claude mcp add --transport stdio \
  --env PLSREADME_API_KEY=$PLSREADME_API_KEY \
  plsreadme -- npx -y plsreadme-mcp

Cursor: ~/.cursor/mcp.json에 추가:

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

VS Code: .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}"
      }
    }
  }
}

Claude Desktop: claude_desktop_config.json에 추가:

{
  "mcpServers": {
    "plsreadme": {
      "command": "npx",
      "args": ["-y", "plsreadme-mcp"],
      "env": {
        "PLSREADME_API_KEY": "<paste-your-personal-api-key>"
      }
    }
  }
}

Windsurf: ~/.codeium/windsurf/mcp_config.json에 추가:

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

참고 사항:

로컬 stdio는 이제 기본적으로 PLSREADME_API_KEY를 기대하므로 새 문서는 소유권이 부여됩니다.
PLSREADME_ALLOW_ANONYMOUS=1을 사용한 명시적 레거시 익명 모드는 여전히 존재합니다.
https://plsreadme.com/my-links에서 키를 생성하세요.

기존 익명 MCP 설정 마이그레이션

이미 plsreadme-mcp를 익명으로 사용한 경우:

/my-links에서 개인 API 키를 생성하세요.
MCP 클라이언트 구성에 PLSREADME_API_KEY를 추가하세요.
이전 워크플로우에 대한 일시적인 호환성 수단으로만 PLSREADME_ALLOW_ANONYMOUS=1을 유지하세요.
여전히 admin_token이 있는 경우 나중에 /api/auth/claim-link로 이전 익명 링크의

Available Tools

5 tools

plsreadme_deleteA

Destructive

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.

ParametersJSON Schema

Name	Required	Description	Default
`id`	No	Document ID to delete.
`file_path`	No	Original file path (looks up the linked doc).

TDQS

A4.2/5.0

Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations mark destructiveHint=true. The description adds that deletion is 'permanently' and reveals that the tool 'Looks up the admin token from the local .plsreadme record file,' which is a behavioral dependency beyond the annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two succinct sentences: first states the primary action, second provides key constraints. No unnecessary words or repetition. Every sentence adds value.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple delete tool with no output schema, the description covers the core action, permanence, and a prerequisite. The token lookup detail is helpful. It could mention error handling or confirmation, but overall is adequate for an agent.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% with both parameters having descriptions. The description adds the critical constraint that 'Requires either the document ID or the original file path,' clarifying that they are alternatives, which the schema's optionality does not convey.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action: 'Delete a plsreadme document permanently.' The verb 'Delete' and the resource 'plsreadme document' are specific. The description distinguishes from siblings (list, share, update) as there is no other delete tool.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides a usage prerequisite: requires either document ID or file path. However, it does not specify when not to use this tool or offer alternatives to alternatives to deletion. The guidance is minimal but present.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

plsreadme_listA

Read-onlyIdempotent

List all plsreadme documents tracked in the local .plsreadme file.

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

ParametersJSON Schema

Name	Required	Description	Default
No parameters

TDQS

A3.8/5.0

Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true, destructiveHint=false, idempotentHint=true. The description adds the detail that it reads from a local file, which is useful but not essential beyond the annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is extremely concise with two sentences that front-load the core action. Every word serves a purpose, and there is no extraneous information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple list operation with no parameters and no output schema, the description adequately covers behavior (lists all documents) and return fields. It does not mention sorting or pagination, but given the tool's simplicity, this is acceptable.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

There are no parameters in the input schema, so the description does not need to add parameter details. Schema coverage is 100% by default, and the description provides no contradictory or missing information.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description specifically states the action (list all documents), the resource (plsreadme documents tracked in the local .plsreadme file), and the output fields (IDs, titles, URLs, source files). It clearly distinguishes from sibling operations like delete, share, and update.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is provided on when to use this tool versus its siblings. There is no mention of prerequisites or alternatives, leaving the agent to infer context from the tool name alone.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

plsreadme_share_fileB

Read-only

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.

ParametersJSON Schema

Name	Required	Description	Default
`file_path`	Yes	Path to the markdown file to share (relative or absolute).

TDQS

B3.4/5.0

Behavior1/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The description contradicts the annotation 'readOnlyHint=true' by stating it uploads the file and may update existing links, indicating a write operation. This is a serious inconsistency, so score 1 as per rules.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Four concise sentences, no redundant information. The first sentence captures the primary purpose, and each subsequent sentence adds relevant detail without excess.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a single-parameter tool with no output schema, the description adequately covers the main behavior: reading, uploading, updating if previously shared, and tracking links. It lacks details on error cases or URL format, but overall sufficient.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% and the parameter 'file_path' is well-described in the schema. The description adds context about reading and uploading the file, but does not significantly add meaning beyond the schema. Baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool shares a local markdown file as a web link, with specific verb 'Share' and resource 'local markdown file'. It distinguishes from siblings like 'share_text' (which shares raw text) and 'update' (which updates existing links).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage when a markdown file needs sharing, and mentions updating existing links. However, it does not explicitly exclude other use cases or provide guidance on when not to use this tool versus alternatives like 'share_text' or 'update'.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

plsreadme_share_textA

Read-only

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.

ParametersJSON Schema

Name	Required	Description	Default
`markdown`	Yes	Content to share. Markdown preferred, but plain text accepted.
`title`	No	Optional title (auto-detected from first H1 if omitted).

TDQS

A3.8/5.0

Behavior1/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations set readOnlyHint=true, but the description describes creating a share link and tracking in a local file, which contradicts that. Description adds context about tracking but fails to resolve the contradiction.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three concise sentences with no wasted words, front-loaded with the main purpose.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

No output schema, but description mentions the return value (permanent URL) and tracking behavior, covering key aspects. Lacks mention of rate limits or authentication, but acceptable for a simple tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, but description adds value by stating markdown is preferred but plain text accepted, and title is auto-detected if omitted.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool shares text as a clean web link, accepts markdown or plain text, and distinguishes from siblings like share_file which handles files.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explains when to use it (to share text) and implies alternatives by naming siblings, but lacks explicit when-not-to-use or exclusion criteria.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

plsreadme_updateA

Idempotent

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.

ParametersJSON Schema

Name	Required	Description
`id`	No	Document ID to update.
`file_path`	No	Original file path (looks up the linked doc).
`markdown`	Yes	New markdown content.

TDQS

A4.4/5.0

Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Adds context beyond annotations: authentication via local file, alternative identifiers. Consistent with idempotentHint=true and readOnlyHint=false. No contradictions.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences, first states action, second details requirements. No redundant information, highly efficient.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Covers action, required params, and identification method. Lacks error handling details or return type, but sufficient for a simple update tool with idempotent hint.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, baseline 3. Description adds meaning by clarifying id and file_path are alternatives, not both required. Enhances understanding of parameter relationships.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb 'Update' and the resource 'existing plsreadme document'. It distinguishes this tool from siblings (delete, list, share) by specifying content update.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Provides guidance on required parameters (either id or file_path) and mentions a prerequisite (admin token lookup). Could explicitly state when to use vs alternatives, but siblings are distinct actions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

5 tool updatesv1.0.1May 4, 2026
- Addedplsreadme_delete
- Addedplsreadme_list
- Addedplsreadme_share_file
- Addedplsreadme_share_text
- Addedplsreadme_update

Deploy Server

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

TDQS

A4/5.0

Scored 2026-05-04 00:35 across 5 tools

Disambiguation5/5

Each tool has a distinct purpose: delete, list, share file, share text, update. There is no ambiguity as descriptions clearly differentiate them.

Naming Consistency5/5

All tools follow the consistent pattern 'plsreadme_verb' with verbs like delete, list, share_file, share_text, update. Naming is uniform and predictable.

Tool Count5/5

With 5 tools covering the core operations of sharing, listing, updating, and deleting documents, the count is well-scoped and appropriate for the service's purpose.

Completeness4/5

The tool set offers full CRUD-like coverage (create via share, read via list, update, delete) but lacks a direct 'get by ID' tool, though list provides IDs and URLs.

Maintenance

ActivityMaintained

ResponsivenessNo issues

Resources

GitHub Repository

Need Help?

Related Servers

Related MCP Connectors

artidrop A
ai.artidrop
Publish HTML, Markdown, and multi-file sites as shareable URLs instantly via MCP.
Content Management Systems Developer Tools
42
mkdshare.DEV A
io.github.PhilipAnd
Publish and share access-controlled Markdown documents from any MCP-enabled AI tool.
Content Management Systems Documentation Access Developer Tools
112
SlidelessOAuth
ai.slideless
List, share, upload, and manage Slideless HTML presentations from any MCP host.
Content Management Systems Workplace & Productivity
2
Context Awesome A
io.github.bh-rat
MCP server for accessing curated awesome list documentation
Documentation Access Research & Data
2259

Related MCP Servers

rustypaste-mcp-server
File Systems Cloud Storage App Automation
rukh-debug
F
license
A
quality
D
maintenance
An MCP server that wraps the rustypaste API, allowing users to upload text, files, and URLs to a rustypaste instance. It supports features such as single-use links, file expiration, and URL shortening.
Updated 6 months ago (2026-03-06 03:44 UTC)
7
29 npm
-
slideless-mcpofficial
Content Management Systems Workplace & Productivity
slideless-ai
F
license
Not graded
quality
C
maintenance
MCP server that wraps the Slideless HTTP API as tools for listing, sharing, uploading, and managing HTML presentations from any MCP host without installing the CLI.
Updated 3 months ago (2026-06-08 20:16 UTC)
-
PasteAIofficial
Note Taking Content Management Systems
pasteai
A
license
A
quality
B
maintenance
An MCP server that lets AI publish markdown documents to a clean, themed web UI. One tool call creates a shareable doc.
Updated 2 months ago (2026-07-19 05:22 UTC)
8
4
MIT
wiki-mcp
Note Taking File Systems Knowledge & Memory
icarus-inte01
F
license
Not graded
quality
D
maintenance
MCP server for managing a personal markdown wiki. Provides search, navigation, read, write, delete, and move tools with automatic index.md management.
Updated 3 months ago (2026-06-16 15:23 UTC)
-

Appeared in Searches

Markdown MCP (Model Context Protocol) Server

문제점

✨ 주요 기능

🚀 빠른 시작

웹

인증 경로 및 출시 상태

API

버전 타임라인 + 안전한 복원

검토 모드 사용 참고 사항 (현재 초안 우선, 타임라인 요청 시)

MCP (AI 편집기)

/versions를 사용한 MCP/에이전트 자동 검토 루프

🔌 MCP 설정

클라이언트 호환성 매트릭스

호스팅 원격 로그인 (지원되는 클라이언트)

호스팅 원격 API 키 폴백

로컬 npm 폴백

기존 익명 MCP 설정 마이그레이션

Available Tools

Tool Schema Changelog

Maintenance

Resources

Related MCP Connectors

Related MCP Servers

slideless-mcpofficial

PasteAIofficial

Appeared in Searches

`/versions`를 사용한 MCP/에이전트 자동 검토 루프