Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Capabilities
Features and capabilities supported by this server
| Capability | Details |
|---|---|
| tools | {
"listChanged": true
} |
| prompts | {
"listChanged": true
} |
| resources | {
"listChanged": true
} |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| 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. |
| 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. |
| plsreadme_list | 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 |