create_guest_token
Create a MiniURL guest token and store it in the current MCP session. Use this when the user has no account yet.
Parameters
No parameters.
Raw schema
{
"type": "object",
"properties": {}
}by addychang
Create, manage, organize, and analyze short links with MiniURL's remote MCP server.
Create, manage, organize, and analyze short links with MiniURL's remote MCP server.
Captured live from the server via tools/list.
Create a MiniURL guest token and store it in the current MCP session. Use this when the user has no account yet.
Parameters
No parameters.
{
"type": "object",
"properties": {}
}Store an existing MiniURL token in the current MCP session. Accepts either a gt_ guest token or an mk_ API key.
| token | string | required | A valid MiniURL guest token (gt_) or API key (mk_). |
{
"type": "object",
"properties": {
"token": {
"type": "string",
"description": "A valid MiniURL guest token (gt_) or API key (mk_)."
}
},
"required": [
"token"
]
}Clear any stored MiniURL authentication from the current MCP session.
Parameters
No parameters.
{
"type": "object",
"properties": {}
}Create a short URL. If no authentication is set, MiniURL automatically starts a guest session for this MCP connection.
| url | string | required | The destination URL to shorten. |
| alias | string | optional | Optional custom alias. Requires a registered account. |
| domain | string | optional | Optional domain. Requires a registered account with an active custom domain. |
| password | string | optional | Optional password. Requires Pro. |
| expiration | string | optional | Optional ISO 8601 expiration datetime. Requires Pro. |
| activated_at | string | optional | Optional ISO 8601 activation datetime. Requires Pro. |
{
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The destination URL to shorten."
},
"alias": {
"type": "string",
"description": "Optional custom alias. Requires a registered account."
},
"domain": {
"type": "string",
"description": "Optional domain. Requires a registered account with an active custom domain."
},
"password": {
"type": "string",
"description": "Optional password. Requires Pro."
},
"expiration": {
"type": "string",
"description": "Optional ISO 8601 expiration datetime. Requires Pro."
},
"activated_at": {
"type": "string",
"description": "Optional ISO 8601 activation datetime. Requires Pro."
}
},
"required": [
"url"
]
}Send a 6-digit registration code to the user email, using the current guest session.
| string | required | The user email address. |
{
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "The user email address."
}
},
"required": [
"email"
]
}Verify the emailed code, create the account, claim guest links, and replace the current guest auth with the new mk_ API key.
| string | required | The user email address. | |
| code | string | required | The 6-digit verification code. |
{
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "The user email address."
},
"code": {
"type": "string",
"description": "The 6-digit verification code."
}
},
"required": [
"email",
"code"
]
}Inspect the current guest/free/pro account status, remaining quota, and feature availability.
Parameters
No parameters.
{
"type": "object",
"properties": {}
}Create a shortened checkout link for upgrading the current registered account to Pro.
| interval | string | optional | Billing interval. Defaults to monthly. |
{
"type": "object",
"properties": {
"interval": {
"type": "string",
"enum": [
"monthly",
"yearly"
],
"description": "Billing interval. Defaults to monthly."
}
}
}List domains available to the current registered account, including miniurl.com and active custom domains.
Parameters
No parameters.
{
"type": "object",
"properties": {}
}List short links for the current registered account.
| limit | string | optional | Optional page size, max 100. |
| offset | string | optional | Optional offset for pagination. |
| search | string | optional | Optional search term for alias or destination URL. |
| domain | string | optional | Optional domain filter. |
{
"type": "object",
"properties": {
"limit": {
"type": "string",
"description": "Optional page size, max 100."
},
"offset": {
"type": "string",
"description": "Optional offset for pagination."
},
"search": {
"type": "string",
"description": "Optional search term for alias or destination URL."
},
"domain": {
"type": "string",
"description": "Optional domain filter."
}
}
}Get a single short link by alias for the current registered account.
| alias | string | required | The link alias to fetch. |
| domain | string | optional | The link domain. Defaults to miniurl.com. |
{
"type": "object",
"properties": {
"alias": {
"type": "string",
"description": "The link alias to fetch."
},
"domain": {
"type": "string",
"description": "The link domain. Defaults to miniurl.com."
}
},
"required": [
"alias"
]
}Update a registered short link. Some fields require Pro.
| alias | string | required | The link alias to update. |
| domain | string | optional | The link domain. Defaults to miniurl.com. |
| url | string | optional | New destination URL. Requires Pro. |
| password | string | optional | Set or replace the password. Requires Pro. |
| clear_password | boolean | optional | Remove the current password. |
| expiration | string | optional | Set a new ISO 8601 expiration datetime. Requires Pro. |
| clear_expiration | boolean | optional | Clear the current expiration. |
| activated_at | string | optional | Set a new ISO 8601 activation datetime. Requires Pro. |
| clear_activated_at | boolean | optional | Clear the current scheduled activation datetime. |
{
"type": "object",
"properties": {
"alias": {
"type": "string",
"description": "The link alias to update."
},
"domain": {
"type": "string",
"description": "The link domain. Defaults to miniurl.com."
},
"url": {
"type": "string",
"description": "New destination URL. Requires Pro."
},
"password": {
"type": "string",
"description": "Set or replace the password. Requires Pro."
},
"clear_password": {
"type": "boolean",
"description": "Remove the current password."
},
"expiration": {
"type": "string",
"description": "Set a new ISO 8601 expiration datetime. Requires Pro."
},
"clear_expiration": {
"type": "boolean",
"description": "Clear the current expiration."
},
"activated_at": {
"type": "string",
"description": "Set a new ISO 8601 activation datetime. Requires Pro."
},
"clear_activated_at": {
"type": "boolean",
"description": "Clear the current scheduled activation datetime."
}
},
"required": [
"alias"
]
}Delete a registered short link permanently.
| alias | string | required | The alias to delete. |
| domain | string | optional | The link domain. Defaults to miniurl.com. |
{
"type": "object",
"properties": {
"alias": {
"type": "string",
"description": "The alias to delete."
},
"domain": {
"type": "string",
"description": "The link domain. Defaults to miniurl.com."
}
},
"required": [
"alias"
]
}Create multiple short links in one request. Free accounts can create up to 10 at a time, Pro up to 50.
| links | array | required |
{
"type": "object",
"properties": {
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"alias": {
"type": "string"
},
"domain": {
"type": "string"
},
"password": {
"type": "string"
},
"expiration": {
"type": "string"
},
"activated_at": {
"type": "string"
}
},
"required": [
"url"
]
}
}
},
"required": [
"links"
]
}Get link analytics. Free accounts receive a basic total plus an upgrade hint; Pro accounts receive full breakdowns.
| alias | string | required | The alias to inspect. |
| domain | string | optional | Optional domain to scope the alias lookup. Defaults to miniurl.com. |
| period | string | optional | Analytics time range. Defaults to 7D. |
{
"type": "object",
"properties": {
"alias": {
"type": "string",
"description": "The alias to inspect."
},
"domain": {
"type": "string",
"description": "Optional domain to scope the alias lookup. Defaults to miniurl.com."
},
"period": {
"type": "string",
"enum": [
"24H",
"7D",
"30D",
"ALL"
],
"description": "Analytics time range. Defaults to 7D."
}
},
"required": [
"alias"
]
}Check whether a custom alias is available on a given domain before creating a link.
| alias | string | required | The alias to check. |
| domain | string | optional | The domain to check on. Defaults to miniurl.com. |
{
"type": "object",
"properties": {
"alias": {
"type": "string",
"description": "The alias to check."
},
"domain": {
"type": "string",
"description": "The domain to check on. Defaults to miniurl.com."
}
},
"required": [
"alias"
]
}List all tags for the current registered account. Tags help organise links into campaigns or categories.
Parameters
No parameters.
{
"type": "object",
"properties": {}
}Create a new tag for organising links. Maximum 20 tags per account.
| name | string | required | Tag name, 1-30 characters. |
| color | string | optional | Tag colour hex code. Defaults to #6b7280 (grey). |
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Tag name, 1-30 characters."
},
"color": {
"type": "string",
"enum": [
"#6b7280",
"#ef4444",
"#f97316",
"#eab308",
"#22c55e",
"#06b6d4",
"#3b82f6",
"#8b5cf6",
"#ec4899"
],
"description": "Tag colour hex code. Defaults to #6b7280 (grey)."
}
},
"required": [
"name"
]
}Delete a tag and remove it from all associated links.
| tag_id | number | required | The tag ID to delete. |
{
"type": "object",
"properties": {
"tag_id": {
"type": "number",
"description": "The tag ID to delete."
}
},
"required": [
"tag_id"
]
}Add a tag to a short link for campaign or category organisation.
| alias | string | required | The link alias to tag. |
| domain | string | optional | The link domain. Defaults to miniurl.com. |
| tag_id | number | required | The tag ID to assign. |
{
"type": "object",
"properties": {
"alias": {
"type": "string",
"description": "The link alias to tag."
},
"domain": {
"type": "string",
"description": "The link domain. Defaults to miniurl.com."
},
"tag_id": {
"type": "number",
"description": "The tag ID to assign."
}
},
"required": [
"alias",
"tag_id"
]
}Remove a tag from a short link.
| alias | string | required | The link alias. |
| domain | string | optional | The link domain. Defaults to miniurl.com. |
| tag_id | number | required | The tag ID to remove. |
{
"type": "object",
"properties": {
"alias": {
"type": "string",
"description": "The link alias."
},
"domain": {
"type": "string",
"description": "The link domain. Defaults to miniurl.com."
},
"tag_id": {
"type": "number",
"description": "The tag ID to remove."
}
},
"required": [
"alias",
"tag_id"
]
}README not available yet.
Hosted server - connect over the network, no local install.
https://workers.miniurl.com/mcpclaude_desktop_config.json
{
"mcpServers": {
"miniurl": {
"command": "npx",
"args": [
"-y",
"mcp-remote",
"https://workers.miniurl.com/mcp"
]
}
}
}Desktop config is stdio-only; this bridges via mcp-remote. Native remote: Settings > Connectors.