citybikes-mcp 1.0.0 → 1.0.2

package/README.md

@@ -19,3 +19,22 @@ node dist/index.js
 ```
 
 Data comes from the public CityBikes aggregation API.
+
+<!-- paywall -->
+## Premium tools
+
+These tools need a license key:
+
+* `network_search`
+* `station_search`
+
+Buy a key at https://mcp-marketplace.io/server/io-github-mrfentmen-citybikes-mcp and set it in your MCP client config:
+
+```json
+"env": { "MCP_LICENSE_KEY": "mcp_live_..." }
+```
+
+The key is checked against MCP Marketplace, cached for 24 hours, and keeps
+working offline once one check has succeeded. Every other tool on this server
+stays free.
+<!-- /paywall -->

package/dist/api.js

@@ -49,3 +49,130 @@ export async function network(args) {
         lines.push(`... and ${total - 20} more stations`);
     return lines.join("\n");
 }
+// ---- muxA tools:
+const BIKES = "https://api.citybik.es/v2";
+function cap(value, fallback, max) {
+    return Math.max(1, Math.min(Math.round(value ?? fallback), max));
+}
+async function cbGet(path) {
+    const res = await fetch(`${BIKES}${path}`, {
+        headers: { "User-Agent": UA, Accept: "application/json" },
+        signal: AbortSignal.timeout(30000),
+    });
+    if (!res.ok)
+        throw new CitybikesError(`CityBikes returned HTTP ${res.status}`);
+    return (await res.json());
+}
+function place(n) {
+    const l = (n.location ?? {});
+    return [l.city, l.state, l.country].filter(Boolean).join(", ") || "location not reported";
+}
+export async function networkSearch(args) {
+    const d = await cbGet("/networks");
+    const all = (d?.networks ?? []);
+    if (!all.length)
+        return "CityBikes returned no networks.";
+    const q = (args.query ?? "").trim().toLowerCase();
+    const country = (args.country ?? "").trim().toLowerCase();
+    let rows = all;
+    if (q)
+        rows = rows.filter((n) => `${n.name ?? ""} ${n.id ?? ""} ${n.company ?? ""} ${place(n)}`.toLowerCase().includes(q));
+    if (country)
+        rows = rows.filter((n) => String((n.location ?? {}).country ?? "").toLowerCase().includes(country));
+    const byCountry = new Map();
+    for (const n of all) {
+        const k = String((n.location ?? {}).country ?? "?");
+        byCountry.set(k, (byCountry.get(k) ?? 0) + 1);
+    }
+    const top = [...byCountry.entries()].sort((a, b) => b[1] - a[1]).slice(0, 8);
+    const out = [
+        `CityBikes networks: ${all.length} across ${byCountry.size} countries.` +
+            `${q ? ` ${rows.length} match "${q}".` : ""}${country ? ` ${rows.length} match country "${country}".` : ""}`,
+        `Most networks by country: ${top.map(([k, v]) => `${k} ${v}`).join(", ")}.`,
+    ];
+    if (args.summary === true) {
+        const topNames = [...rows].sort((a, b) => String(a.name).length - String(b.name).length).slice(0, cap(args.limit, 25, 50));
+        for (const n of topNames) {
+            out.push(`  ${n.name ?? "?"} (${n.id ?? "?"}) | ${place(n)}${n.company ? ` | operated by ${n.company}` : ""}`);
+        }
+        return out.join("\n");
+    }
+    if (!rows.length)
+        return out.join("\n") + `\nNo network matched${country ? ` country "${country}"` : ""}${q ? ` "${q}"` : ""}.`;
+    const limit = cap(args.limit, 20, 60);
+    out.push("", `Matches (${rows.length}):`);
+    for (const [i, n] of rows.slice(0, limit).entries()) {
+        out.push(`  ${i + 1}. ${n.name ?? "?"} | id ${n.id ?? "?"} | ${place(n)}` +
+            `${n.company ? ` | operator ${n.company}` : ""}${n.gbfs_href ? " | GBFS feed" : ""}`);
+    }
+    if (rows.length > limit)
+        out.push(`  plus ${rows.length - limit} more`);
+    return out.join("\n");
+}
+export async function stationSearch(args) {
+    const id = (args.network ?? "").trim();
+    if (!id)
+        throw new CitybikesError("Provide a network id, e.g. joco-new-york.");
+    const d = await cbGet(`/networks/${encodeURIComponent(id)}`);
+    const n = d?.network;
+    if (!n)
+        return `CityBikes has no network with id "${id}". Try network_search to list valid ids.`;
+    const stations = (n.stations ?? []);
+    if (!stations.length)
+        return `${n.name ?? id} reports no stations.`;
+    let rows = stations;
+    const q = (args.query ?? "").trim().toLowerCase();
+    if (q)
+        rows = rows.filter((s) => String(s.name ?? "").toLowerCase().includes(q));
+    if (args.has_bikes === true)
+        rows = rows.filter((s) => Number(s.free_bikes ?? 0) > 0);
+    if (args.has_slots === true)
+        rows = rows.filter((s) => Number(s.empty_slots ?? 0) > 0);
+    if (!rows.length) {
+        return `${n.name ?? id} has ${stations.length} station(s) but none matched${q ? ` the name "${q}"` : ""}${args.has_bikes ? " with bikes" : ""}${args.has_slots ? " with empty slots" : ""}.`;
+    }
+    const limit = cap(args.limit, 20, 200);
+    const ranked = [...rows].sort((a, b) => Number(b.free_bikes ?? 0) - Number(a.free_bikes ?? 0));
+    const busiest = stations.reduce((a, b) => (Number(b.free_bikes ?? 0) > Number(a.free_bikes ?? 0) ? b : a));
+    const freshest = stations.map((s) => Number(s.timestamp ?? 0)).filter((t) => t > 0).sort((a, b) => b - a)[0];
+    return [
+        `Stations in ${n.name ?? id} (${place(n)}): ${rows.length} of ${stations.length} match, showing ${Math.min(limit, rows.length)} ranked by bikes available.`,
+        `Most stocked: ${busiest.name ?? "?"} with ${busiest.free_bikes ?? 0} bikes and ${busiest.empty_slots ?? 0} empty slots.`,
+        freshest ? `Data timestamp ${new Date(freshest * 1000).toISOString().replace("T", " ").slice(0, 19)} UTC.` : "No station timestamps reported.",
+        ...ranked.slice(0, limit).map((s, i) => `${i + 1}. ${s.name ?? "?"} | bikes ${s.free_bikes ?? 0} | slots ${s.empty_slots ?? 0}` +
+            ` | ${Number(s.latitude ?? 0).toFixed(5)}, ${Number(s.longitude ?? 0).toFixed(5)}` +
+            `${s.extra?.ebikes != null ? ` | e-bikes ${s.extra.ebikes}` : ""} | station id ${s.id ?? "?"}`),
+    ].join("\n");
+}
+export async function networkCapacity(args) {
+    const id = (args.network ?? "").trim();
+    if (!id)
+        throw new CitybikesError("Provide a network id, e.g. joco-new-york.");
+    const d = await cbGet(`/networks/${encodeURIComponent(id)}`);
+    const n = d?.network;
+    if (!n)
+        return `CityBikes has no network with id "${id}". Try network_search to list valid ids.`;
+    const stations = (n.stations ?? []);
+    if (!stations.length)
+        return `${n.name ?? id} reports no stations, so no capacity can be computed.`;
+    const free = stations.reduce((a, s) => a + (Number(s.free_bikes) || 0), 0);
+    const slots = stations.reduce((a, s) => a + (Number(s.empty_slots) || 0), 0);
+    const withBikes = stations.filter((s) => Number(s.free_bikes ?? 0) > 0).length;
+    const full = stations.filter((s) => Number(s.empty_slots ?? 0) === 0).length;
+    const empty = stations.filter((s) => Number(s.free_bikes ?? 0) === 0).length;
+    const ebikes = stations.reduce((a, s) => a + (Number(s.extra?.ebikes) || 0), 0);
+    const ebikeStations = stations.filter((s) => Number(s.extra?.ebikes ?? 0) > 0).length;
+    const total = free + slots;
+    const mean = total / stations.length;
+    const sd = Math.sqrt(stations.reduce((a, s) => a + (Number(s.free_bikes ?? 0) - mean) ** 2, 0) / stations.length);
+    return [
+        `${n.name ?? id} | ${place(n)}`,
+        `${stations.length} stations | ${free.toLocaleString("en-US")} bikes free | ${slots.toLocaleString("en-US")} empty slots | ${total.toLocaleString("en-US")} total capacity`,
+        `Stations with at least one bike: ${withBikes} of ${stations.length} (${((withBikes / stations.length) * 100).toFixed(1)}%)`,
+        `Completely full stations: ${full} | completely empty stations: ${empty}`,
+        ebikes || ebikeStations ? `E-bikes: ${ebikes} available across ${ebikeStations} station(s)` : "No e-bike data reported",
+        `Bikes per station: mean ${mean.toFixed(2)}, standard deviation ${sd.toFixed(2)}` +
+            (mean ? `, coefficient of variation ${((sd / mean) * 100).toFixed(1)}%` : ""),
+        `Operator: ${n.company ?? "not reported"}${n.ebikes != null ? ` | network level e-bikes ${n.ebikes}` : ""}`,
+    ].join("\n");
+}

package/dist/license.js

@@ -0,0 +1,79 @@
+// Premium tools on this server need a license key bought from MCP Marketplace.
+// Buyers put the key in their MCP client config as MCP_LICENSE_KEY. Every tool
+// that is not listed in PREMIUM keeps working without a key.
+const SLUG = "citybikes-mcp";
+// Tools that need a key. Everything else is free.
+const PREMIUM = new Set([
+    "network_search",
+    "station_search",
+]);
+const BUY_URL = `https://mcp-marketplace.io/server/io-github-mrfentmen-${SLUG}`;
+// The license check calls the marketplace's verify endpoint directly instead of
+// using @mcp_marketplace/license. That SDK sends no `apikey` header, so every
+// check it makes is rejected by Supabase before it reaches the function. The
+// publishable key below is public by design - it ships in mcp-marketplace.io's
+// own JavaScript and only ever reaches their licence check.
+const DEFAULT_VERIFY_URL = "https://virupvwhtkpkjsiskckg.supabase.co/functions/v1/verify-key";
+const PUBLISHABLE_KEY = "sb_publishable_BuqlW96Ke8C_zzJG-LQv1Q_YHi_r_4h";
+const OK_CACHE_MS = 60 * 60 * 1000;
+const BAD_CACHE_MS = 60 * 1000;
+const seen = new Map();
+const REASONS = {
+    missing_key: "no key is set",
+    invalid_format: "that key is not a valid MCP Marketplace key",
+    not_found: "that key was not found",
+    revoked: "that key has been revoked",
+    rotated: "that key was rotated, use your new one",
+    expired: "that key has expired, renew it",
+    rate_limited: "there were too many checks just now, try again shortly",
+    network_error: "the license server could not be reached",
+};
+function blocked(tool, reason) {
+    const why = REASONS[reason] ?? `the license server answered "${reason}"`;
+    return `"${tool}" needs a license key, but ${why}. ` +
+        `Set MCP_LICENSE_KEY in your MCP client config. Get a key: ${BUY_URL}`;
+}
+async function verify(key) {
+    const res = await fetch(process.env.MCP_LICENSE_VERIFY_URL || DEFAULT_VERIFY_URL, {
+        method: "POST",
+        headers: {
+            apikey: PUBLISHABLE_KEY,
+            Authorization: `Bearer ${PUBLISHABLE_KEY}`,
+            "Content-Type": "application/json",
+        },
+        body: JSON.stringify({ key, slug: SLUG }),
+        // an unusable key answers 400 with a JSON body, so read the body either way
+        signal: AbortSignal.timeout(15000),
+    });
+    const data = (await res.json());
+    if (typeof data?.valid !== "boolean")
+        return { valid: false, reason: "unexpected_response" };
+    return data;
+}
+/**
+ * Returns null when the caller may run the tool, or a short message telling
+ * them how to get a key.
+ *
+ * A good key is remembered for an hour, so a busy session does not hit the
+ * license server on every call and keeps working through a brief outage.
+ */
+export async function premiumRequired(tool) {
+    if (!PREMIUM.has(tool))
+        return null;
+    const key = process.env.MCP_LICENSE_KEY;
+    if (!key)
+        return blocked(tool, "missing_key");
+    const hit = seen.get(key);
+    if (hit && Date.now() - hit.at < (hit.valid ? OK_CACHE_MS : BAD_CACHE_MS)) {
+        return hit.valid ? null : blocked(tool, hit.reason ?? "invalid");
+    }
+    let result;
+    try {
+        result = await verify(key);
+    }
+    catch {
+        result = { valid: false, reason: "network_error" };
+    }
+    seen.set(key, { ...result, at: Date.now() });
+    return result.valid ? null : blocked(tool, result.reason ?? "invalid");
+}

package/dist/server.js

@@ -1,7 +1,8 @@
 import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { z } from "zod";
 import { network } from "./api.js";
-import { networks } from "./api.js";
+import { networks, networkSearch, stationSearch, networkCapacity } from "./api.js";
+import { premiumRequired } from "./license.js";
 const text = (value) => ({ content: [{ type: "text", text: value }] });
 const textError = (t) => ({ content: [{ type: "text", text: t }], isError: true });
 const READ_ONLY = { readOnlyHint: true, openWorldHint: true };
@@ -34,5 +35,54 @@ export function createServer() {
             return textError(error(e));
         }
     });
+    server.registerTool("network_search", {
+        title: "Network search",
+        description: "Search the CityBikes directory of bike share systems by name, id, operator, city or country, with a breakdown of how many networks operate in each country.",
+        inputSchema: z.object({ query: z.string().describe("Name, id or operator fragment.").optional(), country: z.string().describe("Country fragment.").optional(), limit: z.number().describe("Max results.").optional(), summary: z.boolean().describe("List matches compactly.").optional() }),
+        annotations: READ_ONLY,
+    }, async (args) => {
+        // ---- paywall: network_search ----
+        const paywallMessage = await premiumRequired("network_search");
+        if (paywallMessage)
+            return { content: [{ type: "text", text: paywallMessage }], isError: true };
+        // ---- paywall: end ----
+        try {
+            return text(await networkSearch(args));
+        }
+        catch (e) {
+            return textError(e instanceof Error ? `Error: ${e.message}` : String(e));
+        }
+    });
+    server.registerTool("station_search", {
+        title: "Station search",
+        description: "Find stations inside a CityBikes network by name or by live availability, ranked by bikes free, with dock counts, coordinates, e-bike numbers and the data timestamp.",
+        inputSchema: z.object({ network: z.string().describe("Network id, e.g. joco-new-york."), query: z.string().describe("Station name fragment.").optional(), has_bikes: z.boolean().describe("Only stations with bikes.").optional(), has_slots: z.boolean().describe("Only stations with empty slots.").optional(), limit: z.number().describe("Max stations.").optional() }),
+        annotations: READ_ONLY,
+    }, async (args) => {
+        // ---- paywall: station_search ----
+        const paywallMessage = await premiumRequired("station_search");
+        if (paywallMessage)
+            return { content: [{ type: "text", text: paywallMessage }], isError: true };
+        // ---- paywall: end ----
+        try {
+            return text(await stationSearch(args));
+        }
+        catch (e) {
+            return textError(e instanceof Error ? `Error: ${e.message}` : String(e));
+        }
+    });
+    server.registerTool("network_capacity", {
+        title: "Network capacity",
+        description: "Live capacity statistics for a CityBikes network: free bikes and empty docks in total, share of stations stocked, completely full and empty stations, e-bike availability and the spread of bikes per station.",
+        inputSchema: z.object({ network: z.string().describe("Network id, e.g. joco-new-york.") }),
+        annotations: READ_ONLY,
+    }, async (args) => {
+        try {
+            return text(await networkCapacity(args));
+        }
+        catch (e) {
+            return textError(e instanceof Error ? `Error: ${e.message}` : String(e));
+        }
+    });
     return server;
 }

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.0.0",
+  "version": "1.0.2",
   "type": "module",
   "repository": {
     "type": "git",

package/server.json

@@ -6,12 +6,12 @@
     "url": "https://github.com/mrfentmen/citybikes-mcp",
     "source": "github"
   },
-  "version": "1.0.0",
+  "version": "1.0.1",
   "packages": [
     {
       "registryType": "npm",
       "identifier": "citybikes-mcp",
-      "version": "1.0.0",
+      "version": "1.0.1",
       "transport": {
         "type": "stdio"
       }