MCP Tools Reference

A concise, skimmable catalog of Bitly MCP tools.

Link Management

create_short_link - Create a compact, shareable link with advanced customization options

Parameters:

long_url (optional; required if bitlink_id not provided)
bitlink_id (optional; existing short link to add custom back-half to)
title (optional)
tags (optional; string[])
domain (optional)
group_guid (optional)
keyword (optional; custom back-half for the short link)
deeplinks (optional)

Usage Examples:

"Shorten https://example.com/very-long-product-page-url"

"Create a short link for https://example.com/spring-sale titled 'Spring Sale 2024' tagged 'marketing' and 'seasonal' using our custom domain"

"Create a custom short link bit.ly/summer-sale for https://example.com/sale"

create_short_link_with_qr - Create a short link and a QR Code that encodes it in a single step (one approval covers both)

Parameters:

group_guid (required)
bitlink_id (optional; required if long_url not provided)
long_url (optional; required if bitlink_id not provided)
domain (optional)
title (optional; used for the short link)
tags (optional; string[])
keyword (optional; custom back-half for the short link)
qr_title (optional; defaults to the link title when omitted)
archived (optional)
render_customizations (optional; object; QR appearance)

Usage Examples:

"Create a short link and matching QR Code for https://example.com/event in my marketing group"

"Make bit.ly/summer-sale for https://example.com/sale and generate a QR Code titled 'Summer Sale Flyer'"

get_short_link_details - Get complete short link details (title, destination, created, creator, tags, custom domains)

Parameters:

bitlink (required)

Usage Examples:

"Show me the full details for bit.ly/ABC123"

update_short_link - Update destination URL, title, archive state, tags, or deeplinks

Parameters:

bitlink (required)
long_url (optional)
title (optional)
archived (optional; boolean)
tags (optional; string[])
deeplinks (optional)

Usage Examples:

"Archive bit.ly/ABC123"

"Update bit.ly/ABC123 with title 'Updated Campaign Link' and tags 'Q1-2024' and 'email-campaign'"

"Change the destination of bit.ly/ABC123 to https://example.com/new-page"

delete_short_link - Permanently delete a short link (unedited links only)

Parameters:

bitlink (required)

Usage Examples:

"Delete bit.ly/ABC123 permanently"

expand - Retrieve the original long URL and basic metadata for a short link

Parameters:

bitlink (required)

Usage Examples:

"What URL does bit.ly/ABC123 point to?"

Analytics

link_metrics - Time-series click metrics for a link

Parameters:

bitlink (required)
unit (optional; minute | hour | day | week | month)
units (optional; number)
unit_reference (optional; ISO timestamp)
size (optional)

Usage Examples:

"Show me click metrics for bit.ly/ABC123"

"Get hourly clicks for bit.ly/ABC123 for the last 48 hours"

link_clicks_summary - Total clicks summary for a link

Parameters:

bitlink (required)
unit (optional)
units (optional)
unit_reference (optional)
size (optional)

Usage Examples:

"How many total clicks has bit.ly/ABC123 received?"

link_engagements - Time-series engagement metrics (clicks + scans + button clicks) for a link

Parameters:

bitlink (required)
unit (optional)
units (optional)
unit_reference (optional)

Usage Examples:

"Show engagements over time for bit.ly/ABC123"

"How did bit.ly/ABC123 perform across clicks and scans for the last 30 days?"

link_engagements_summary - Total engagement counts (clicks + scans + button clicks) for a link

Parameters:

bitlink (required)
unit (optional)
units (optional)
unit_reference (optional)

Usage Examples:

"What are the total engagements for bit.ly/ABC123 this month?"

link_countries - Click breakdown by country

Parameters:

bitlink (required)
unit (optional)
units (optional)
unit_reference (optional)
size (optional)

Usage Examples:

"Which countries clicked bit.ly/ABC123 in the last 7 days?"

link_cities - Click breakdown by city

Parameters:

bitlink (required)
unit (optional)
units (optional)
unit_reference (optional)
size (optional)

Usage Examples:

"Which cities generated the most clicks this month for bit.ly/ABC123?"

link_devices - Click breakdown by device type

Parameters:

bitlink (required)
unit (optional)
units (optional)
unit_reference (optional)
size (optional)

Usage Examples:

"Show the device breakdown for bit.ly/ABC123"

link_referrers - Click breakdown by referring source

Parameters:

bitlink (required)
unit (optional)
units (optional)
unit_reference (optional)
size (optional)

Usage Examples:

"What websites are referring traffic to bit.ly/ABC123?"

link_referring_domains - Click breakdown by referring domain

Parameters:

bitlink (required)
unit (optional)
units (optional)
unit_reference (optional)
size (optional)

Usage Examples:

"Which domains are sending the most traffic to bit.ly/ABC123?"

QR Codes

create_qr_code - Create a new QR Code for a link

Parameters:

bitlink (required)
title (optional)
group_guid (optional)
render_customizations (optional; object; foreground/background colors, gradients, frame, dot pattern)

Usage Examples:

"Create a QR Code for bit.ly/ABC123 called 'Event Registration'"

"Create a QR Code for bit.ly/ABC123 titled 'Event Registration' in my marketing group"

"Create a QR Code for bit.ly/ABC123 with a blue foreground and white background"

get_qr_code - Get QR Code metadata

Parameters:

qr_code_id (required)

Usage Examples:

"Show details for QR Code QR123456"

get_qr_code_image - Get a URL to download the QR Code image

Parameters:

qr_code_id (required)

Usage Examples:

"Get the image for QR Code QR123456"

update_qr_code - Update a QR Code's title, customizations, or archived status

Parameters:

qr_code_id (required)
title (optional)
archived (optional; boolean)
render_customizations (optional; object; foreground/background colors, gradients, frame, dot pattern)

Usage Examples:

"Update QR Code QR123456 with title 'Updated Event QR' and archive it"

"Recolor QR Code QR123456 with a red foreground"

get_group_qr_codes - List QR Codes in a group with filtering and pagination

Parameters:

group_guid (required)
query (optional)
size (optional)
page (optional)

Usage Examples:

"Show QR Codes in group Bg123def456 that contain 'event'"

User & Organization

get_user - Get the authenticated user's profile

Parameters:

none

Usage Examples:

"Show my user profile"

get_organizations - List organizations the user can access

Parameters:

none

Usage Examples:

"List all organizations I can access"

get_groups - List groups (workspaces); optionally filter by organization

Parameters:

organization_guid (optional)

Usage Examples:

"Show all my groups"

get_group_details - Get a group's details

Parameters:

group_guid (required)

Usage Examples:

"Get details for group Bg123def456"

get_group_short_links - List links in a group with rich filtering

Parameters:

group_guid (required)
size (optional)
page (optional)
keyword (optional)
query (optional)
created_before (optional)
created_after (optional)
modified_after (optional)
archived (optional)
deeplinks (optional)
domain_deeplinks (optional)
campaign_guid (optional)
channel_guid (optional)
custom_bitlink (optional)
tags (optional)
encoding_user (optional)

Usage Examples:

"Show links in group Bg123def456"

"Get the first 20 links in group Bg123def456 tagged 'campaign' created after 2024-01-01 (exclude archived)"

get_group_short_links_sorted - List group links sorted by performance

Parameters:

group_guid (required)
sort (optional; clicks)
unit (optional)
units (optional)
unit_reference (optional)
size (optional)

Usage Examples:

"Show top-performing links in group Bg123def456 by clicks over the last 30 days"

Custom Domains

get_custom_domains - List custom domains available to the user

Parameters:

none

Usage Examples:

"What custom domains can I use for shortening links?"

get_custom_link_details - Get custom link metadata and override history

Parameters:

custom_bitlink (required)

Usage Examples:

"Show details for example.ly/spring-sale"

Bulk Uploads

bulk_upload_validate - Validate a bulk upload request and obtain a signed URL for uploading a .CSV or .XLSX file

Parameters:

filename (required)
upload_type (required; "link", "qr_code", or "coupled_link")
group_guid (optional)
domain (optional)
template_id (optional; required for "qr_code" and "coupled_link"; "QTDTmplWLogo" or "QTDTmplNLogo")

Usage Examples:

"Bulk upload links.csv into group Bg123def456"

"Bulk create QR Codes from qr-batch.xlsx using the no-logo template"

bulk_upload_file - Upload a file to the signed URL returned by bulk_upload_validate

Parameters:

upload_url (required)
headers (required; object)
file_content (required)
content_type (optional)

Usage Examples:

"Upload the validated bulk file to complete the bulk request"