{
  "markdown": "# ShortURLMCP\n\n<!-- mcp-name: io.github.AceDataCloud/mcp-shorturl -->\n\n[![PyPI version](https://img.shields.io/pypi/v/mcp-shorturl.svg)](https://pypi.org/project/mcp-shorturl/)\n[![PyPI downloads](https://img.shields.io/pypi/dm/mcp-shorturl.svg)](https://pypi.org/project/mcp-shorturl/)\n[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![MCP](https://img.shields.io/badge/MCP-Compatible-green.svg)](https://modelcontextprotocol.io)\n\nA [Model Context Protocol (MCP)](https://modelcontextprotocol.io) server for URL shortening using [Short URL API](https://platform.acedata.cloud/documents/shorturl) through the [AceDataCloud API](https://platform.acedata.cloud).\n\nCreate short, shareable URLs directly from Claude, VS Code, or any MCP-compatible client.\n\n## Features\n\n- **URL Shortening** - Convert long URLs into short, shareable links\n- **Batch Shortening** - Shorten multiple URLs at once (up to 10 per batch)\n- **Free Service** - Zero credit consumption per request\n- **Permanent Links** - Short URLs never expire\n- **surl.id Domain** - Short URLs use the clean `surl.id` domain\n- **Bearer Auth** - Secure API access with token authentication\n\n## Tool Reference\n\n| Tool | Description |\n|------|-------------|\n| `shorturl_create` | Create a short URL from a long URL. |\n| `shorturl_batch_create` | Create short URLs for multiple long URLs in a single batch. |\n| `shorturl_get_usage_guide` | Get a comprehensive guide for using the ShortURL tools. |\n| `shorturl_get_api_info` | Get information about the ShortURL API service. |\n\n## Quick Start\n\n### 1. Get Your API Token\n\n1. Sign up at [AceDataCloud Platform](https://platform.acedata.cloud)\n2. Go to the [API documentation page](https://platform.acedata.cloud/documents/shorturl)\n3. Click **\"Acquire\"** to get your API token\n4. Copy the token for use below\n\n### 2. Use the Hosted Server (Recommended)\n\nAceDataCloud hosts a managed MCP server — **no local installation required**.\n\n**Endpoint:** `https://shorturl.mcp.acedata.cloud/mcp`\n\nAll requests require a Bearer token. Use the API token from Step 1.\n\n#### Claude.ai\n\nConnect directly on [Claude.ai](https://claude.ai) with OAuth — **no API token needed**:\n\n1. Go to Claude.ai **Settings → Integrations → Add More**\n2. Enter the server URL: `https://shorturl.mcp.acedata.cloud/mcp`\n3. Complete the OAuth login flow\n4. Start using the tools in your conversation\n\n#### Claude Desktop\n\nAdd to your config (`~/Library/Application Support/Claude/claude_desktop_config.json` on macOS):\n\n```json\n{\n  \"mcpServers\": {\n    \"shorturl\": {\n      \"type\": \"streamable-http\",\n      \"url\": \"https://shorturl.mcp.acedata.cloud/mcp\",\n      \"headers\": {\n        \"Authorization\": \"Bearer YOUR_API_TOKEN\"\n      }\n    }\n  }\n}\n```\n\n#### Cursor / Windsurf\n\nAdd to your MCP config (`.cursor/mcp.json` or `.windsurf/mcp.json`):\n\n```json\n{\n  \"mcpServers\": {\n    \"shorturl\": {\n      \"type\": \"streamable-http\",\n      \"url\": \"https://shorturl.mcp.acedata.cloud/mcp\",\n      \"headers\": {\n        \"Authorization\": \"Bearer YOUR_API_TOKEN\"\n      }\n    }\n  }\n}\n```\n\n#### VS Code (Copilot)\n\nAdd to your VS Code MCP config (`.vscode/mcp.json`):\n\n```json\n{\n  \"servers\": {\n    \"shorturl\": {\n      \"type\": \"streamable-http\",\n      \"url\": \"https://shorturl.mcp.acedata.cloud/mcp\",\n      \"headers\": {\n        \"Authorization\": \"Bearer YOUR_API_TOKEN\"\n      }\n    }\n  }\n}\n```\n\nOr install the [Ace Data Cloud MCP extension](https://marketplace.visualstudio.com/items?itemName=acedatacloud.acedatacloud-mcp) for VS Code, which registers the hosted MCP servers with one-click setup.\n\n#### JetBrains IDEs\n\n1. Go to **Settings → Tools → AI Assistant → Model Context Protocol (MCP)**\n2. Click **Add** → **HTTP**\n3. Paste:\n\n```json\n{\n  \"mcpServers\": {\n    \"shorturl\": {\n      \"url\": \"https://shorturl.mcp.acedata.cloud/mcp\",\n      \"headers\": {\n        \"Authorization\": \"Bearer YOUR_API_TOKEN\"\n      }\n    }\n  }\n}\n```\n\n\n#### Claude Code\n\nClaude Code supports MCP servers natively:\n\n```bash\nclaude mcp add shorturl --transport http https://shorturl.mcp.acedata.cloud/mcp \\\n  -h \"Authorization: Bearer YOUR_API_TOKEN\"\n```\n\nOr add to your project's `.mcp.json`:\n\n```json\n{\n  \"mcpServers\": {\n    \"shorturl\": {\n      \"type\": \"streamable-http\",\n      \"url\": \"https://shorturl.mcp.acedata.cloud/mcp\",\n      \"headers\": {\n        \"Authorization\": \"Bearer YOUR_API_TOKEN\"\n      }\n    }\n  }\n}\n```\n\n#### Cline\n\nAdd to Cline's MCP settings (`.cline/mcp_settings.json`):\n\n```json\n{\n  \"mcpServers\": {\n    \"shorturl\": {\n      \"type\": \"streamable-http\",\n      \"url\": \"https://shorturl.mcp.acedata.cloud/mcp\",\n      \"headers\": {\n        \"Authorization\": \"Bearer YOUR_API_TOKEN\"\n      }\n    }\n  }\n}\n```\n\n#### Amazon Q Developer\n\nAdd to your MCP configuration:\n\n```json\n{\n  \"mcpServers\": {\n    \"shorturl\": {\n      \"type\": \"streamable-http\",\n      \"url\": \"https://shorturl.mcp.acedata.cloud/mcp\",\n      \"headers\": {\n        \"Authorization\": \"Bearer YOUR_API_TOKEN\"\n      }\n    }\n  }\n}\n```\n\n#### Roo Code\n\nAdd to Roo Code MCP settings:\n\n```json\n{\n  \"mcpServers\": {\n    \"shorturl\": {\n      \"type\": \"streamable-http\",\n      \"url\": \"https://shorturl.mcp.acedata.cloud/mcp\",\n      \"headers\": {\n        \"Authorization\": \"Bearer YOUR_API_TOKEN\"\n      }\n    }\n  }\n}\n```\n\n#### Continue.dev\n\nAdd to `.continue/config.yaml`:\n\n```yaml\nmcpServers:\n  - name: shorturl\n    type: streamable-http\n    url: https://shorturl.mcp.acedata.cloud/mcp\n    headers:\n      Authorization: \"Bearer YOUR_API_TOKEN\"\n```\n\n#### Zed\n\nAdd to Zed's settings (`~/.config/zed/settings.json`):\n\n```json\n{\n  \"language_models\": {\n    \"mcp_servers\": {\n      \"shorturl\": {\n        \"url\": \"https://shorturl.mcp.acedata.cloud/mcp\",\n        \"headers\": {\n          \"Authorization\": \"Bearer YOUR_API_TOKEN\"\n        }\n      }\n    }\n  }\n}\n```\n\n#### cURL Test\n\n```bash\n# Health check (no auth required)\ncurl https://shorturl.mcp.acedata.cloud/health\n\n# MCP initialize\ncurl -X POST https://shorturl.mcp.acedata.cloud/mcp \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Accept: application/json\" \\\n  -H \"Authorization: Bearer YOUR_API_TOKEN\" \\\n  -d '{\"jsonrpc\":\"2.0\",\"id\":1,\"method\":\"initialize\",\"params\":{\"protocolVersion\":\"2025-03-26\",\"capabilities\":{},\"clientInfo\":{\"name\":\"test\",\"version\":\"1.0\"}}}'\n```\n\n### 3. Or Run Locally (Alternative)\n\nIf you prefer to run the server on your own machine:\n\n```bash\n# Install from PyPI\npip install mcp-shorturl\n# or\nuvx mcp-shorturl\n\n# Set your API token\nexport ACEDATACLOUD_API_TOKEN=\"your_token_here\"\n\n# Run (stdio mode for Claude Desktop / local clients)\nmcp-shorturl\n\n# Run (HTTP mode for remote access)\nmcp-shorturl --transport http --port 8000\n```\n\n#### Claude Desktop (Local)\n\n```json\n{\n  \"mcpServers\": {\n    \"shorturl\": {\n      \"command\": \"uvx\",\n      \"args\": [\"mcp-shorturl\"],\n      \"env\": {\n        \"ACEDATACLOUD_API_TOKEN\": \"your_token_here\"\n      }\n    }\n  }\n}\n```\n\n#### Docker (Self-Hosting)\n\n```bash\ndocker pull ghcr.io/acedatacloud/mcp-shorturl:latest\ndocker run -p 8000:8000 ghcr.io/acedatacloud/mcp-shorturl:latest\n```\n\nClients connect with their own Bearer token — the server extracts the token from each request's `Authorization` header.\n\n## Available Tools\n\n### URL Shortening Tools\n\n| Tool                    | Description                            |\n| ----------------------- | -------------------------------------- |\n| `shorturl_create`       | Shorten a single URL                   |\n| `shorturl_batch_create` | Shorten multiple URLs at once (max 10) |\n\n### Information Tools\n\n| Tool                       | Description                     |\n| -------------------------- | ------------------------------- |\n| `shorturl_get_usage_guide` | Get comprehensive usage guide   |\n| `shorturl_get_api_info`    | Get API details and error codes |\n\n## Usage Examples\n\n### Shorten a Single URL\n\n```\nUser: Shorten this URL: https://platform.acedata.cloud/documents/shorturl\n\nClaude: I'll shorten that URL for you.\n[Calls shorturl_create with url=\"https://platform.acedata.cloud/documents/shorturl\"]\n\nResult: https://surl.id/1uHCs01xa5\n```\n\n### Batch Shorten Multiple URLs\n\n```\nUser: Shorten these URLs for my social media posts:\n- https://example.com/blog/very-long-article-title-about-ai\n- https://example.com/products/new-release-2024\n\nClaude: I'll shorten both URLs at once.\n[Calls shorturl_batch_create with urls=[...]]\n```\n\n### Create Links for Documentation\n\n```\nUser: I need clean short links for these reference URLs in my doc.\n\nClaude: I'll create short links for all your references.\n[Calls shorturl_batch_create with the list of URLs]\n```\n\n## Response Structure\n\n### Successful Response\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"url\": \"https://surl.id/1uHCs01xa5\"\n  }\n}\n```\n\n### Error Response\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"api_error\",\n    \"message\": \"fetch failed\"\n  },\n  \"trace_id\": \"2cf86e86-22a4-46e1-ac2f-032c0f2a4e89\"\n}\n```\n\n## Configuration\n\n### Environment Variables\n\n| Variable                    | Description                 | Default                     |\n| --------------------------- | --------------------------- | --------------------------- |\n| `ACEDATACLOUD_API_TOKEN`    | API token from AceDataCloud | **Required**                |\n| `ACEDATACLOUD_API_BASE_URL` | API base URL                | `https://api.acedata.cloud` |\n| `ACEDATACLOUD_OAUTH_CLIENT_ID`  | OAuth client ID (hosted mode) | —                           |\n| `ACEDATACLOUD_PLATFORM_BASE_URL` | Platform base URL            | `https://platform.acedata.cloud` |\n| `SHORTURL_REQUEST_TIMEOUT`  | Request timeout in seconds  | `30`                        |\n| `LOG_LEVEL`                 | Logging level               | `INFO`                      |\n\n### Command Line Options\n\n```bash\nmcp-shorturl --help\n\nOptions:\n  --version          Show version\n  --transport        Transport mode: stdio (default) or http\n  --port             Port for HTTP transport (default: 8000)\n```\n\n## Development\n\n### Setup Development Environment\n\n```bash\n# Clone repository\ngit clone https://github.com/AceDataCloud/ShortURLMCP.git\ncd ShortURLMCP\n\n# Create virtual environment\npython -m venv .venv\nsource .venv/bin/activate  # or `.venv\\Scripts\\activate` on Windows\n\n# Install with dev dependencies\npip install -e \".[dev,test]\"\n```\n\n### Run Tests\n\n```bash\n# Run unit tests\npytest\n\n# Run with coverage\npytest --cov=core --cov=tools\n\n# Run integration tests (requires API token)\npytest tests/test_integration.py -m integration\n```\n\n### Code Quality\n\n```bash\n# Format code\nruff format .\n\n# Lint code\nruff check .\n\n# Type check\nmypy core tools\n```\n\n### Build & Publish\n\n```bash\n# Install build dependencies\npip install -e \".[release]\"\n\n# Build package\npython -m build\n\n# Upload to PyPI\ntwine upload dist/*\n```\n\n## Project Structure\n\n```\nShortURLMCP/\n├── core/                   # Core modules\n│   ├── __init__.py\n│   ├── client.py          # HTTP client for ShortURL API\n│   ├── config.py          # Configuration management\n│   ├── exceptions.py      # Custom exceptions\n│   └── server.py          # MCP server initialization\n├── tools/                  # MCP tool definitions\n│   ├── __init__.py\n│   ├── shorturl_tools.py  # URL shortening tools\n│   └── info_tools.py      # Information tools\n├── prompts/                # MCP prompt templates\n│   └── __init__.py\n├── tests/                  # Test suite\n│   ├── conftest.py\n│   ├── test_client.py\n│   ├── test_config.py\n│   └── test_integration.py\n├── deploy/                 # Deployment configs\n│   ├── run.sh\n│   └── production/\n│       ├── deployment.yaml\n│       ├── ingress.yaml\n│       └── service.yaml\n├── .env.example           # Environment template\n├── .gitignore\n├── .ruff.toml             # Ruff linter configuration\n├── CHANGELOG.md\n├── Dockerfile             # Docker image for HTTP mode\n├── docker-compose.yaml    # Docker Compose config\n├── LICENSE\n├── main.py                # Entry point\n├── pyproject.toml         # Project configuration\n└── README.md\n```\n\n## API Reference\n\nThis server wraps the [AceDataCloud Short URL API](https://platform.acedata.cloud/documents/shorturl):\n\n- **Endpoint**: `POST /shorturl`\n- **Input**: `{ \"content\": \"https://long-url.example.com/...\" }`\n- **Output**: `{ \"success\": true, \"data\": { \"url\": \"https://surl.id/...\" } }`\n- **Pricing**: Free (0 credits)\n- **Auth**: Bearer token\n\nFull API documentation: [AceDataCloud Platform](https://platform.acedata.cloud/documents/shorturl)\n\n## Documentation\n\n<!-- canonical-documentation -->\n[Documentation](https://platform.acedata.cloud/documents/short-url-mcp)\n\n## License\n\nMIT License - see [LICENSE](LICENSE) for details.\n",
  "bytes": 12668,
  "sha": "ecd9da2006ec348854303a3b8b4e59ae908500d887ab87cfece2826e702702ab",
  "repo_slug": "acedatacloud/shorturlmcp",
  "fonte": "repo",
  "truncated": false,
  "api": "https://agentalog.com/api/listings/mcp_io_github_acedatacloud_mcp_shorturl_c52e05af/readme"
}