plsreadme
Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Instructions
Guidance the server publishes about itself, which clients place ahead of the tool catalog so the model reads it before choosing anything.
This server publishes no instructions, or was last inspected before Glama recorded them.
Capabilities
Features and capabilities supported by this server
Protocol revision2025-11-25
| Capability | Details |
|---|---|
| tools | {
"listChanged": true
} |
| prompts | {
"listChanged": true
} |
| resources | {
"listChanged": true
} |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| plsreadme_share_fileB | 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_textA | 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_updateA | 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. |
| plsreadme_deleteA | 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. |
| plsreadme_listA | List all plsreadme documents tracked in the local .plsreadme file. Shows document IDs, titles, URLs, and source files. |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
| share-document | Share markdown or plain text as a readable web link |
| refactor-and-share | Use your own model to refactor raw text into clean markdown, then share with plsreadme |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
| plsreadme-api | plsreadme API information and limits |
TDQS
Scored across 5 tools
Each tool has a distinct purpose: delete, list, share file, share text, update. There is no ambiguity as descriptions clearly differentiate them.
All tools follow the consistent pattern 'plsreadme_verb' with verbs like delete, list, share_file, share_text, update. Naming is uniform and predictable.
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.
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.