@bn-shortner/shortener-mcp 0.0.0-stage → 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 BroadNet Technologies LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,43 @@
-# Temporary Holding Version
+# BN Shortener MCP server
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Lets AI assistants work with your [BN Shortener](https://b1.lc) account: create and change short links, read
+click statistics, run Launch Check before a campaign, see links that need attention, make QR codes and bio pages.
+
+## Hosted (recommended)
+
+Add `https://b1.lc/mcp` as a remote MCP server / custom connector. You sign in to BN Shortener and choose what the
+assistant may do; disconnect it any time in **Settings → Security → Connected Apps**.
+
+- Claude (claude.ai, desktop): Settings → Connectors → Add custom connector → `https://b1.lc/mcp`
+- Claude Code: `claude mcp add --transport http bn-shortener https://b1.lc/mcp`
+- VS Code / Cursor and others: a server of type `http` with URL `https://b1.lc/mcp`
+
+## Local (stdio), for clients that only start local servers
+
+```json
+{
+  "mcpServers": {
+    "bn-shortener": {
+      "command": "npx",
+      "args": ["-y", "@bn-shortner/shortener-mcp"],
+      "env": { "BN_API_KEY": "bn_live_..." }
+    }
+  }
+}
+```
+
+It forwards to the hosted server with the API key (dashboard: **API Portal → API keys**); the key's permissions
+decide what the assistant can do. Node 20+.
+
+## Tools
+
+create_link, list_links, get_link, update_link, archive_link, delete_link (to Trash, 30 days), get_link_stats,
+bulk_create_links, run_launch_check, get_link_health, check_url_safety, create_qr_code (returns the image),
+list_qr_codes, get_qr_code_image, get_qr_code_stats, create_bio_page, add_bio_page_link, list_bio_pages,
+get_account_usage, list_campaigns, create_campaign, add_links_to_campaign, get_campaign_stats, list_utm_presets,
+add_smart_rule, start_ab_test, get_ab_test_results,
+list_domains.
+
+## License
+
+MIT

package/bin/bn-mcp.js

@@ -0,0 +1,75 @@
+#!/usr/bin/env node
+// BN Shortener MCP server over stdio, for MCP clients that only start local servers. It forwards every JSON-RPC
+// message to the hosted server (https://b1.lc/mcp) with your API key, so the tools are always the current ones.
+//   BN_API_KEY=bn_live_...  npx -y @bn-shortner/shortener-mcp
+// Clients that support remote servers can connect to https://b1.lc/mcp directly (sign in with OAuth, no key).
+'use strict';
+const readline = require('node:readline');
+
+const VERSION = '1.0.0';
+const URL_ = process.env.BN_MCP_URL || 'https://b1.lc/mcp';
+const KEY = process.env.BN_API_KEY || '';
+const TIMEOUT_MS = Number(process.env.BN_MCP_TIMEOUT_MS || 120000);
+
+const write = (msg) => process.stdout.write(JSON.stringify(msg) + '\n');
+const log = (...a) => process.stderr.write(`[bn-mcp] ${a.join(' ')}\n`);
+const errorFor = (msg, code, message) => (msg && msg.id !== undefined && msg.method ? { jsonrpc: '2.0', id: msg.id, error: { code, message } } : null);
+
+async function forward(line) {
+  let msg;
+  try {
+    msg = JSON.parse(line);
+  } catch {
+    write({ jsonrpc: '2.0', id: null, error: { code: -32700, message: 'Parse error' } });
+    return;
+  }
+  if (!KEY) {
+    const e = errorFor(msg, -32001, 'Set BN_API_KEY to a BN Shortener API key (dashboard: API Portal, API keys).');
+    if (e) write(e);
+    return;
+  }
+  const ctrl = new AbortController();
+  const timer = setTimeout(() => ctrl.abort(), TIMEOUT_MS);
+  try {
+    const resp = await fetch(URL_, {
+      method: 'POST', signal: ctrl.signal,
+      headers: { 'Content-Type': 'application/json', Accept: 'application/json, text/event-stream', Authorization: `Bearer ${KEY}`,
+                 'User-Agent': `bn-shortener-mcp/${VERSION}` },
+      body: line,
+    });
+    const text = await resp.text();
+    if (resp.status === 202 || !text) return; // notification accepted
+    if (resp.status === 401) {
+      const e = errorFor(msg, -32001, 'BN Shortener refused the API key (BN_API_KEY): it is wrong, revoked or expired.');
+      if (e) write(e);
+      return;
+    }
+    let body;
+    try {
+      body = JSON.parse(text);
+    } catch {
+      const e = errorFor(msg, -32603, `BN Shortener answered HTTP ${resp.status}`);
+      if (e) write(e);
+      return;
+    }
+    if (body && (body.jsonrpc || Array.isArray(body))) {
+      write(body);
+    } else {
+      const e = errorFor(msg, -32603, (body && (body.detail || body.title || body.error_description)) || `HTTP ${resp.status}`);
+      if (e) write(e);
+    }
+  } catch (err) {
+    const e = errorFor(msg, -32603, `Could not reach ${URL_}: ${err && err.name === 'AbortError' ? 'timed out' : err.message}`);
+    if (e) write(e);
+  } finally {
+    clearTimeout(timer);
+  }
+}
+
+if (!KEY) log('BN_API_KEY is not set: every request will fail. Create a key in the dashboard (API Portal, API keys).');
+const rl = readline.createInterface({ input: process.stdin, terminal: false });
+let chain = Promise.resolve(); // answer in order
+rl.on('line', (line) => {
+  if (line.trim()) chain = chain.then(() => forward(line));
+});
+rl.on('close', () => chain.then(() => process.exit(0)));

package/package.json

@@ -1,6 +1,39 @@
 {
   "name": "@bn-shortner/shortener-mcp",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.0",
+  "description": "BN Shortener (b1.lc) MCP server for AI assistants: short links, statistics, Launch Check, QR codes, bio pages",
+  "license": "MIT",
+  "author": {
+    "name": "BroadNet Technologies LLC",
+    "email": "support@broadnet.me",
+    "url": "https://b1.lc"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/BN-Shortner/bn-shortener-mcp.git"
+  },
+  "bugs": {
+    "url": "https://github.com/BN-Shortner/bn-shortener-mcp/issues",
+    "email": "support@broadnet.me"
+  },
+  "homepage": "https://b1.lc/docs/tools/mcp/",
+  "keywords": [
+    "mcp",
+    "model context protocol",
+    "url shortener",
+    "qr codes",
+    "b1.lc",
+    "broadnet"
+  ],
+  "bin": {
+    "bn-mcp": "bin/bn-mcp.js"
+  },
+  "files": [
+    "bin",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=20"
+  }
+}