AI Agent Integration

ULink provides a Model Context Protocol (MCP) server that enables AI coding agents to manage deep links programmatically. AI agents can authenticate developers, create projects, configure platforms, and set up deep linking — all without the developer visiting the dashboard.

Quick Start

1. Install the MCP Server

npx @ulinkly/mcp-server@latest

Or add to your MCP client configuration (Claude Code, Cursor, Windsurf):

{
  "mcpServers": {
    "ulink": {
      "command": "npx",
      "args": ["-y", "@ulinkly/mcp-server@latest"]
    }
  }
}

2. Authenticate

Call the check_auth_status tool to see if credentials exist. If not, call authenticate — it opens a browser window where the developer can sign in or create a free account.

3. Create a Project and Set Up Deep Links

After authentication, create a project with create_project, then check get_onboarding_status to see what steps remain. Use the remaining MCP tools to configure domains, platforms, and create links.

For guided setup, invoke the @ulinkly/setup onboarding skill which walks through all 7 phases automatically.

MCP Tool Reference

Tool	Category	Auth Required	Description
check_auth_status	Auth	No	Check if valid credentials exist
authenticate	Auth	No	Open browser for sign-in or sign-up
get_onboarding_status	Onboarding	Yes	Get setup progress and next step
list_projects	Projects	Yes	List all projects
create_project	Projects	Yes	Create a new project
get_project	Projects	Yes	Get project details
update_project	Projects	Yes	Update project name or URL
configure_project	Projects	Yes	Update platform config
create_link	Links	Yes	Create a unified deep link
list_links	Links	Yes	List links for a project
get_link	Links	Yes	Get link details
update_link	Links	Yes	Update a link
delete_link	Links	Yes	Delete a link
get_link_analytics	Links	Yes	Get click analytics
list_domains	Domains	Yes	List domains for a project
add_domain	Domains	Yes	Add a custom domain
verify_domain	Domains	Yes	Verify domain DNS
delete_domain	Domains	Yes	Remove a domain
list_api_keys	API Keys	Yes	List API keys
create_api_key	API Keys	Yes	Create a new API key
revoke_api_key	API Keys	Yes	Revoke an API key
get_subscription	Account	Yes	Get subscription details
list_plans	Account	Yes	List available plans
get_usage	Account	Yes	Get usage statistics

Common Workflows

Set Up Deep Linking for a New App

1. authenticate — Sign in or create account
2. create_project — Create a new project with your app name
3. get_onboarding_status — See what steps remain
4. add_domain — Add a shared.ly subdomain or custom domain
5. configure_project — Set iOS bundle ID, Android package name, URL schemes
6. Run ulink verify via CLI to validate configuration
7. create_link — Create your first deep link

Create a Short Link

1. list_projects — Find your project ID
2. create_link — Create a link with destination URLs for each platform

Check Analytics

1. list_links — Find the link ID
2. get_link_analytics — View clicks by device, platform, country, referrer

Environment Variables

Variable	Description	Default
ULINK_API_KEY	API key for authentication (alternative to browser OAuth)	—
ULINK_API_URL	API base URL	https://api.ulink.ly
ULINK_FRONTEND_URL	Frontend URL for OAuth flow	https://ulink.ly

Authentication Methods

The MCP server supports two authentication methods:

1. Browser OAuth (default) — The authenticate tool opens a browser for sign-in. Tokens are stored encrypted in ~/.ulink/config.json.
2. API Key — Set the ULINK_API_KEY environment variable. Get an API key from the dashboard or via the create_api_key tool.

Related

• AI-Assisted Setup Guide — Guided onboarding skill
• MCP Server Setup — Detailed MCP configuration
• REST API Reference — Direct API integration