How to Use Zulk Remote MCP

The Zulk Remote MCP (Model Context Protocol) server allows you to integrate URL shortening capabilities directly into your AI workflows. This guide will walk you through setting up and using the Zulk MCP server.

Prerequisites

Before you begin, make sure you have:

A Zulk account with API access
Your Zulk API credentials
An MCP-compatible AI client (like Claude Desktop)

Installation

Step 1: Install the MCP Server

The Zulk MCP server can be installed using uvx:

uvx zulk-mcp-server

Step 2: Configure Your MCP Client

Add the following configuration to your MCP client's configuration file:

{
  "mcpServers": {
    "zulk": {
      "command": "uvx",
      "args": ["zulk-mcp-server"],
      "env": {
        "ZULK_API_KEY": "your-api-key-here",
        "ZULK_BASE_URL": "https://zu.lk"
      }
    }
  }
}

Usage

Once configured, you can use the following MCP tools in your AI conversations:

Shorten URLs

Use the shorten_url tool to create short links:

Please shorten this URL: https://example.com/very/long/url/path

Get Link Analytics

Retrieve analytics for your shortened links:

Show me the analytics for the short link: zu.lk/abc123

List Your Links

Get a list of all your shortened links:

Show me all my shortened links

Advanced Configuration

Custom Domains

If you have a custom domain configured in Zulk, you can specify it in the environment variables:

{
  "env": {
    "ZULK_API_KEY": "your-api-key-here",
    "ZULK_BASE_URL": "https://your-domain.com"
  }
}

Rate Limiting

The MCP server respects Zulk's API rate limits. If you encounter rate limiting, the server will automatically retry with exponential backoff.

Troubleshooting

Common Issues

Authentication Error: Make sure your API key is correct and has the necessary permissions.

Connection Error: Verify that your internet connection is stable and that zu.lk is accessible.

Rate Limiting: If you're hitting rate limits, consider upgrading your Zulk plan or reducing the frequency of requests.

Next Steps

Explore the Zulk API documentation for more advanced features
Check out other MCP integrations available
Join our community for support and tips

Need help? Contact our support team for assistance.