English Français العربية

io.github.ysalitrynskyi/opn-mcp

السجل الرسمي التسويق والمبيعات

MCP server for opn.onl: shorten links, analytics, branded QR codes, and link management.

الشيفرة المصدرية التوثيق

التثبيت

أضف هذا إلى إعدادات MCP في عميلك (Claude Desktop: claude_desktop_config.json، وCursor: ‏.cursor/mcp.json، ويستخدم VS Code وغيره الصيغة نفسها «mcpServers»).

NPM package opn-mcp
Claude Code 
claude mcp add opn-mcp -e 'OPN_API_KEY=<your opn_api_key>' -e 'OPN_BASE_URL=https://l.opn.onl' -- npx -y opn-mcp@1.2.0
إعداد JSON (Claude Desktop وCursor وVS Code) 
{
    "mcpServers": {
        "opn-mcp": {
            "command": "npx",
            "args": [
                "-y",
                "opn-mcp@1.2.0"
            ],
            "env": {
                "OPN_API_KEY": "<your opn_api_key>",
                "OPN_BASE_URL": "https://l.opn.onl"
            }
        }
    }
}

متغيرات البيئة

  • OPN_API_KEY إلزامي سري Your opn.onl API key (create one under Settings → API Keys).
  • OPN_BASE_URL API base URL. Set this to your own instance's API for a self-hosted opn.onl.

التوثيق

مأخوذ من ملف README للمشروع على GitHub ويُحدَّث أسبوعيًا. تفتح الروابط على GitHub.

المحتويات
  1. opn-mcp
  2. Setup
  3. Configuration
  4. Tools
  5. Example prompts
  6. Development
  7. Releasing
  8. License

opn-mcp

An MCP server for opn.onl — the open-source, self-hostable URL shortener. It lets AI assistants (Claude Desktop, Cursor, etc.) shorten links, read analytics, generate QR codes, and manage links in natural language.

Works against the hosted service or your own self-hosted instance.

Setup

1. Get an API key

On your opn.onl instance, go to Settings → API Keys, create a key, and copy it (it starts with opn_ and is shown once).

2. Add the server to your MCP client

Claude Desktop — edit claude_desktop_config.json (~/Library/Application Support/Claude/ on macOS, %APPDATA%\Claude\ on Windows):

{
  "mcpServers": {
    "opn": {
      "command": "npx",
      "args": ["-y", "opn-mcp"],
      "env": {
        "OPN_API_KEY": "opn_your_key_here"
      }
    }
  }
}

Restart your client. That's it — it talks to the hosted API (https://l.opn.onl) by default.

Prefer to run from source? Swap the args for the GitHub build — same config: "args": ["-y", "github:ysalitrynskyi/opn-mcp"] (it builds on install).

Self-hosted instance

Point OPN_BASE_URL at your own instance's API host:

{
  "mcpServers": {
    "opn": {
      "command": "npx",
      "args": ["-y", "opn-mcp"],
      "env": {
        "OPN_API_KEY": "opn_your_key_here",
        "OPN_BASE_URL": "https://l.your-domain.com"
      }
    }
  }
}

Configuration

Env varRequiredDefaultDescription
OPN_API_KEY✅—Your API key (opn_…), from Settings → API Keys
OPN_BASE_URL—https://l.opn.onlAPI base URL — set this for a self-hosted instance

Tools

Links

ToolDescription
shorten_urlCreate a short link — optional alias, title, notes, scheduling (starts_at/expires_at), max_clicks, password, burn-after-reading, folder and tags
shorten_urls_bulkShorten many URLs at once, optionally into a folder
list_linksList your links (limit, offset, search, folder or tag filter)
update_linkUpdate destination, title, notes, scheduling, click limit, folder or protections; clear fields with remove_* flags
delete_linkDelete a link
clone_linkDuplicate a link under a fresh short code
toggle_link_pinPin or unpin a link
check_alias_availableCheck whether a custom alias is free before using it

Analytics

ToolDescription
get_link_statsPer-link analytics (clicks, unique visitors, geo, cities, devices, browsers, OS, referrers); optional days window
get_dashboard_statsAccount-wide analytics across all your links

QR & URL helpers

ToolDescription
get_qr_codeGet a link's QR image — optional brand colour, centre logo, PNG/SVG
check_url_healthCheck a destination URL is reachable before shortening
build_utm_urlAppend UTM campaign parameters to a URL
preview_url_metadataFetch Open Graph metadata (title, description, image) for a URL

Tags & folders

ToolDescription
list_tags / create_tagList or create tags
add_tags_to_link / remove_tags_from_linkAttach or detach tags on a link
list_folders / create_folderList or create folders
move_links_to_folderMove links into a folder

Example prompts

  • "Shorten https://example.com/very/long/url and call it launch-2026"
  • "Shorten these five URLs into a new folder called Q3 Campaign"
  • "How many clicks did link 42 get in the last 30 days, and from which countries?"
  • "Give me a branded SVG QR code for link 42"
  • "Tag my last 10 links as 'newsletter' and show my dashboard stats"
  • "Build a UTM link for https://example.com — source newsletter, medium email"

Development

npm install
npm run build      # tsc → dist/
npm test           # vitest
OPN_API_KEY=opn_… npm run dev   # run from source (stdio)

Releasing

All three registries are owned by ysalitrynskyi (npm user, GitHub user, and the io.github.ysalitrynskyi MCP-registry namespace), so publishing must be done while signed in as that account.

  1. Bump the version in three places and keep them identical: package.json, server.json (top-level and the packages[0].version), and SERVER_VERSION in src/server.ts.
  2. Land it: commit to main and push. CI (.github/workflows/ci.yml) runs build + test — it does not publish.
  3. Publish to npm (as npm user ysalitrynskyi):
     npm login
 npm publish        # prepublishOnly runs the build
  4. Publish to the MCP registry (as GitHub user ysalitrynskyi):
     mcp-publisher validate      # optional, offline check
 mcp-publisher login github  # interactive browser OAuth
 mcp-publisher publish

Smithery (smithery.yaml) and Glama (glama.json) track the npm/registry release automatically — no separate step.

License

MIT © ysalitrynskyi. Part of the opn.onl project.

الأسئلة الشائعة

ما هو io.github.ysalitrynskyi/opn-mcp؟

MCP server for opn.onl: shorten links, analytics, branded QR codes, and link management.

كيف أثبّت io.github.ysalitrynskyi/opn-mcp؟

يعمل على جهازك. في Claude Code: claude mcp add opn-mcp -e 'OPN_API_KEY=<your opn_api_key>' -e 'OPN_BASE_URL=https://l.opn.onl' -- npx -y opn-mcp@1.2.0. وفي العملاء الآخرين، الصق إعداد JSON من هذه الصفحة في إعدادات MCP الخاصة بهم.

هل يحتاج io.github.ysalitrynskyi/opn-mcp إلى مفتاح API؟

نعم. يتطلب OPN_API_KEY، وتضبطها في إعداداته.

هل io.github.ysalitrynskyi/opn-mcp مفتوح المصدر؟

نعم. شيفرته متاحة على GitHub بترخيص MIT.

من يصون io.github.ysalitrynskyi/opn-mcp؟

ينشره ysalitrynskyi. يدرجه AI.tn لكنه لا يصونه ولا يوصي به.

من سجل MCP الرسمي. الإدراج ليس توصية: راجع شيفرة الخادم وصلاحياته قبل منحه الوصول إلى بياناتك.