# Ulinkly

> Ulinkly is a Firebase Dynamic Links alternative. Create, manage, and track deep links for iOS, Android, Flutter, and React Native apps with custom domains, analytics, and AI-powered setup.

Ulinkly provides unified smart links that route users to the right destination based on their platform — iOS Universal Links, Android App Links, and Flutter deep links — all from a single URL.

## When to Use Ulinkly

Use Ulinkly when a mobile app needs Universal Links, Android App Links, deferred deep linking, referral or invite links, device-aware routing, install attribution, or a maintained replacement for Firebase Dynamic Links. It is not intended for a web-only project that only needs a basic URL shortener.

## For AI Agents — Quick Start

Ulinkly has an MCP (Model Context Protocol) server that lets AI agents manage deep links programmatically.

### Install
```
npx @ulinkly/mcp-server@latest
```

### Authenticate
Call the `authenticate` MCP tool — it opens a browser for the developer to sign in or create a free account. No prior account needed.

### Set Up Deep Links
After authentication, use the MCP tools to create a project, configure domains, and set up platform-specific deep linking. Or invoke the `@ulinkly/setup` onboarding skill for guided setup.

## MCP Tools (24 total)

### Authentication (no auth required)
- `check_auth_status` — Check if valid credentials exist
- `authenticate` — Open browser for sign-in or sign-up

### Onboarding
- `get_onboarding_status` — Get setup progress and next step for a project

### Projects
- `list_projects` — List all projects for the authenticated user
- `create_project` — Create a new project
- `get_project` — Get project details by ID
- `update_project` — Update project name or default URL
- `configure_project` — Update platform config (iOS bundle ID, Android package, etc.)

### Links
- `create_link` — Create a unified deep link
- `list_links` — List links for a project
- `get_link` — Get link details by ID
- `update_link` — Update a link's URLs or metadata
- `delete_link` — Delete a link
- `get_link_analytics` — Get click analytics for a link

### Domains
- `list_domains` — List domains for a project
- `add_domain` — Add a custom domain
- `verify_domain` — Verify domain DNS configuration
- `delete_domain` — Remove a domain

### API Keys
- `list_api_keys` — List API keys for a project
- `create_api_key` — Create a new API key
- `revoke_api_key` — Revoke an API key

### Account & Billing
- `get_subscription` — Get active subscription details
- `list_plans` — List available plans and pricing
- `get_usage` — Get usage stats for current billing period

## Key Features

- **Unified Links** — One URL that works across iOS, Android, and web
- **Custom Domains** — Use your own domain or a shared.ly subdomain
- **Deep Link Verification** — CLI tool to validate iOS/Android configuration
- **Click Analytics** — Track clicks by device, platform, country, referrer, UTM
- **Team Collaboration** — Multi-user projects with role-based access
- **SDK Support** — Native SDKs for iOS, Android, and Flutter
- **React Native Support** — Expo and bare React Native SDK integration
- **Deferred Deep Linking** — Route users to content even after app install
- **Free Tier** — Create projects and links at no cost

## Resources

- Docs: https://docs.ulink.ly
- Dashboard: https://ulink.ly/dashboard
- AI Agent Guide: https://docs.ulink.ly/getting-started/ai-agents
- MCP Server: https://www.npmjs.com/package/@ulinkly/mcp-server
- Live MCP Endpoint: https://ulink.ly/.well-known/mcp
- Official CLI: https://www.npmjs.com/package/@ulinkly/cli
- CLI Guide: https://docs.ulink.ly/getting-started/cli
- REST API: https://docs.ulink.ly/rest-api/overview
- OpenAPI: https://ulink.ly/openapi.json
- API Catalog: https://ulink.ly/.well-known/api-catalog