MCP Server Integration

LimeLink provides a Model Context Protocol (MCP) server that brings documentation, guided workflows, and link management directly into your AI coding assistant.

No API key required to get started! Documentation, SDK setup guides, and prompt templates work without any configuration.

What is MCP?

MCP (Model Context Protocol) is an open protocol that connects AI assistants to external tools and data sources. The LimeLink MCP server lets your AI assistant:

• Access LimeLink documentation in real time
• Follow guided workflows for link creation and SDK setup
• Create and manage dynamic links directly from your AI assistant

Features

Quick Start

Without API Key (Documentation & Guides)

Connect and start exploring LimeLink documentation and setup guides immediately:

{
  "mcpServers": {
    "limelink": {
      "command": "npx",
      "args": ["-y", "limelink-mcp-server"]
    }
  }
}

Try asking your AI assistant:

• "Read the LimeLink getting-started docs"
• "How do I set up deep linking for iOS?"
• "Show me the LimeLink SDK integration guide"

With API Key (Full Features)

Add your API key to unlock link creation and management tools:

{
  "mcpServers": {
    "limelink": {
      "command": "npx",
      "args": ["-y", "limelink-mcp-server"],
      "env": {
        "LIMELINK_API_KEY": "your_api_key_here"
      }
    }
  }
}

Setup

Claude Code

Use the claude mcp add command:

# Without API key (docs & guides only)
claude mcp add --scope user --transport stdio limelink -- npx -y limelink-mcp-server

# With API key (full features)
claude mcp add --scope user --transport stdio limelink \
  --env LIMELINK_API_KEY=your_api_key_here \
  -- npx -y limelink-mcp-server

Scope options:

• --scope user — Available in all projects
• --scope project — Saved to .mcp.json (shareable with team via Git)

Claude Desktop

Add the JSON configuration to your Claude Desktop config file:

{
  "mcpServers": {
    "limelink": {
      "command": "npx",
      "args": ["-y", "limelink-mcp-server"],
      "env": {
        "LIMELINK_API_KEY": "your_api_key_here"
      }
    }
  }
}

Other MCP Clients

Any MCP-compatible client can connect using the standard JSON configuration pattern:

{
  "mcpServers": {
    "limelink": {
      "command": "npx",
      "args": ["-y", "limelink-mcp-server"],
      "env": {
        "LIMELINK_API_KEY": "your_api_key_here"
      }
    }
  }
}

Global Install

For faster startup, install the package globally:

npm install -g limelink-mcp-server

Then use limelink-mcp-server as the command instead of npx:

{
  "mcpServers": {
    "limelink": {
      "command": "limelink-mcp-server",
      "env": {
        "LIMELINK_API_KEY": "your_api_key_here"
      }
    }
  }
}

Environment Variables

Get your API key from the LimeLink Dashboard.

Tools

create-link

Create a dynamic link with platform-specific deep linking, social previews, and UTM tracking.

Example usage in AI assistant:

"Create a dynamic link for https://example.com/product/123 with suffix 'product-123' and enable analytics"

get-link-by-suffix

Look up a dynamic link by its suffix.

Example usage:

"Look up the dynamic link with suffix 'summer-promo'"

get-link-by-url

Look up a dynamic link by its full URL. Automatically extracts the suffix from both URL formats:

• Free plan: https://deep.limelink.org/{suffix}
• Pro plan: https://{project}.limelink.org/link/{suffix}

Example usage:

"Look up the link at https://myapp.limelink.org/link/summer-promo"

Documentation Resources

The MCP server provides access to all LimeLink documentation pages:

Prompt Templates

create-dynamic-link

Guided workflow for creating a dynamic link.

Scenario: Use when you need help creating a new dynamic link with platform-specific settings.

setup-deep-linking

Guided workflow for setting up LimeLink SDK deep linking.

Scenario: Use when setting up deep linking in your app for the first time.

Usage Examples

Ask your AI assistant questions like:

• "Read the LimeLink docs and help me set up deep linking for my iOS app"
• "Create a dynamic link for my product page with UTM tracking"
• "What's the difference between Universal Links and Deferred Deep Links?"
• "Look up the status of my 'summer-promo' link"
• "Help me integrate the LimeLink Android SDK"
• "Show me how to handle deferred deep links in Swift"

Notes

Relationship with llms.txt

• llms.txt is a static documentation file hosted at https://limelink.org/llms.txt that AI agents can fetch directly.
• MCP Server provides interactive, real-time access to the same documentation plus tools for link management.
• Both serve AI coding assistants but through different mechanisms — llms.txt is passive, MCP is interactive.

Caching

Documentation fetches are cached in memory with a 1-hour TTL for fast repeated access.

Rate Limiting

API tool calls (create-link, get-link-by-suffix, get-link-by-url) are subject to the standard LimeLink API rate limits.