Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| YOURLS_API_URL | No | URL to your YOURLS API endpoint | |
| YOURLS_PASSWORD | No | Password for password-based auth | |
| YOURLS_USERNAME | No | Username for password-based auth | |
| YOURLS_AUTH_METHOD | No | Authentication method (signature or password) | signature |
| YOURLS_SIGNATURE_TTL | No | Time-to-live for signatures in seconds | 43200 |
| YOURLS_SIGNATURE_TOKEN | No | Secret token for signature-based auth |
Schema
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| shorten_url | Shorten a long URL using YOURLS |
| expand_url | Expand a short URL to its original long URL |
| url_stats | Get statistics for a shortened URL |
| db_stats | Get global statistics for the YOURLS instance |
| url_analytics | Get detailed click analytics for a shortened URL within a date range |
| contract_url | Check if a URL has already been shortened without creating a new short URL |
| update_url | Update an existing short URL to point to a different destination URL |
| change_keyword | Change the keyword of an existing short URL |
| get_url_keyword | Get the keyword(s) for a long URL |
| delete_url | Delete a short URL |
| list_urls | Get a list of URLs with sorting, pagination, and filtering options |
| generate_qr_code | Generate a QR code for a shortened URL |
| create_custom_url | Create a custom short URL with a specific keyword, even for URLs that already exist in the database |
| shorten_with_analytics | Shorten a long URL with Google Analytics UTM parameters |