citybikes-mcp 1.0.2 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +0 -17
- package/dist/api.js +0 -80
- package/dist/server.js +9 -19
- package/package.json +2 -2
- package/dist/license.js +0 -79
package/README.md
CHANGED
|
@@ -20,21 +20,4 @@ node dist/index.js
|
|
|
20
20
|
|
|
21
21
|
Data comes from the public CityBikes aggregation API.
|
|
22
22
|
|
|
23
|
-
<!-- paywall -->
|
|
24
|
-
## Premium tools
|
|
25
23
|
|
|
26
|
-
These tools need a license key:
|
|
27
|
-
|
|
28
|
-
* `network_search`
|
|
29
|
-
* `station_search`
|
|
30
|
-
|
|
31
|
-
Buy a key at https://mcp-marketplace.io/server/io-github-mrfentmen-citybikes-mcp and set it in your MCP client config:
|
|
32
|
-
|
|
33
|
-
```json
|
|
34
|
-
"env": { "MCP_LICENSE_KEY": "mcp_live_..." }
|
|
35
|
-
```
|
|
36
|
-
|
|
37
|
-
The key is checked against MCP Marketplace, cached for 24 hours, and keeps
|
|
38
|
-
working offline once one check has succeeded. Every other tool on this server
|
|
39
|
-
stays free.
|
|
40
|
-
<!-- /paywall -->
|
package/dist/api.js
CHANGED
|
@@ -51,9 +51,6 @@ export async function network(args) {
|
|
|
51
51
|
}
|
|
52
52
|
// ---- muxA tools:
|
|
53
53
|
const BIKES = "https://api.citybik.es/v2";
|
|
54
|
-
function cap(value, fallback, max) {
|
|
55
|
-
return Math.max(1, Math.min(Math.round(value ?? fallback), max));
|
|
56
|
-
}
|
|
57
54
|
async function cbGet(path) {
|
|
58
55
|
const res = await fetch(`${BIKES}${path}`, {
|
|
59
56
|
headers: { "User-Agent": UA, Accept: "application/json" },
|
|
@@ -67,83 +64,6 @@ function place(n) {
|
|
|
67
64
|
const l = (n.location ?? {});
|
|
68
65
|
return [l.city, l.state, l.country].filter(Boolean).join(", ") || "location not reported";
|
|
69
66
|
}
|
|
70
|
-
export async function networkSearch(args) {
|
|
71
|
-
const d = await cbGet("/networks");
|
|
72
|
-
const all = (d?.networks ?? []);
|
|
73
|
-
if (!all.length)
|
|
74
|
-
return "CityBikes returned no networks.";
|
|
75
|
-
const q = (args.query ?? "").trim().toLowerCase();
|
|
76
|
-
const country = (args.country ?? "").trim().toLowerCase();
|
|
77
|
-
let rows = all;
|
|
78
|
-
if (q)
|
|
79
|
-
rows = rows.filter((n) => `${n.name ?? ""} ${n.id ?? ""} ${n.company ?? ""} ${place(n)}`.toLowerCase().includes(q));
|
|
80
|
-
if (country)
|
|
81
|
-
rows = rows.filter((n) => String((n.location ?? {}).country ?? "").toLowerCase().includes(country));
|
|
82
|
-
const byCountry = new Map();
|
|
83
|
-
for (const n of all) {
|
|
84
|
-
const k = String((n.location ?? {}).country ?? "?");
|
|
85
|
-
byCountry.set(k, (byCountry.get(k) ?? 0) + 1);
|
|
86
|
-
}
|
|
87
|
-
const top = [...byCountry.entries()].sort((a, b) => b[1] - a[1]).slice(0, 8);
|
|
88
|
-
const out = [
|
|
89
|
-
`CityBikes networks: ${all.length} across ${byCountry.size} countries.` +
|
|
90
|
-
`${q ? ` ${rows.length} match "${q}".` : ""}${country ? ` ${rows.length} match country "${country}".` : ""}`,
|
|
91
|
-
`Most networks by country: ${top.map(([k, v]) => `${k} ${v}`).join(", ")}.`,
|
|
92
|
-
];
|
|
93
|
-
if (args.summary === true) {
|
|
94
|
-
const topNames = [...rows].sort((a, b) => String(a.name).length - String(b.name).length).slice(0, cap(args.limit, 25, 50));
|
|
95
|
-
for (const n of topNames) {
|
|
96
|
-
out.push(` ${n.name ?? "?"} (${n.id ?? "?"}) | ${place(n)}${n.company ? ` | operated by ${n.company}` : ""}`);
|
|
97
|
-
}
|
|
98
|
-
return out.join("\n");
|
|
99
|
-
}
|
|
100
|
-
if (!rows.length)
|
|
101
|
-
return out.join("\n") + `\nNo network matched${country ? ` country "${country}"` : ""}${q ? ` "${q}"` : ""}.`;
|
|
102
|
-
const limit = cap(args.limit, 20, 60);
|
|
103
|
-
out.push("", `Matches (${rows.length}):`);
|
|
104
|
-
for (const [i, n] of rows.slice(0, limit).entries()) {
|
|
105
|
-
out.push(` ${i + 1}. ${n.name ?? "?"} | id ${n.id ?? "?"} | ${place(n)}` +
|
|
106
|
-
`${n.company ? ` | operator ${n.company}` : ""}${n.gbfs_href ? " | GBFS feed" : ""}`);
|
|
107
|
-
}
|
|
108
|
-
if (rows.length > limit)
|
|
109
|
-
out.push(` plus ${rows.length - limit} more`);
|
|
110
|
-
return out.join("\n");
|
|
111
|
-
}
|
|
112
|
-
export async function stationSearch(args) {
|
|
113
|
-
const id = (args.network ?? "").trim();
|
|
114
|
-
if (!id)
|
|
115
|
-
throw new CitybikesError("Provide a network id, e.g. joco-new-york.");
|
|
116
|
-
const d = await cbGet(`/networks/${encodeURIComponent(id)}`);
|
|
117
|
-
const n = d?.network;
|
|
118
|
-
if (!n)
|
|
119
|
-
return `CityBikes has no network with id "${id}". Try network_search to list valid ids.`;
|
|
120
|
-
const stations = (n.stations ?? []);
|
|
121
|
-
if (!stations.length)
|
|
122
|
-
return `${n.name ?? id} reports no stations.`;
|
|
123
|
-
let rows = stations;
|
|
124
|
-
const q = (args.query ?? "").trim().toLowerCase();
|
|
125
|
-
if (q)
|
|
126
|
-
rows = rows.filter((s) => String(s.name ?? "").toLowerCase().includes(q));
|
|
127
|
-
if (args.has_bikes === true)
|
|
128
|
-
rows = rows.filter((s) => Number(s.free_bikes ?? 0) > 0);
|
|
129
|
-
if (args.has_slots === true)
|
|
130
|
-
rows = rows.filter((s) => Number(s.empty_slots ?? 0) > 0);
|
|
131
|
-
if (!rows.length) {
|
|
132
|
-
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" : ""}.`;
|
|
133
|
-
}
|
|
134
|
-
const limit = cap(args.limit, 20, 200);
|
|
135
|
-
const ranked = [...rows].sort((a, b) => Number(b.free_bikes ?? 0) - Number(a.free_bikes ?? 0));
|
|
136
|
-
const busiest = stations.reduce((a, b) => (Number(b.free_bikes ?? 0) > Number(a.free_bikes ?? 0) ? b : a));
|
|
137
|
-
const freshest = stations.map((s) => Number(s.timestamp ?? 0)).filter((t) => t > 0).sort((a, b) => b - a)[0];
|
|
138
|
-
return [
|
|
139
|
-
`Stations in ${n.name ?? id} (${place(n)}): ${rows.length} of ${stations.length} match, showing ${Math.min(limit, rows.length)} ranked by bikes available.`,
|
|
140
|
-
`Most stocked: ${busiest.name ?? "?"} with ${busiest.free_bikes ?? 0} bikes and ${busiest.empty_slots ?? 0} empty slots.`,
|
|
141
|
-
freshest ? `Data timestamp ${new Date(freshest * 1000).toISOString().replace("T", " ").slice(0, 19)} UTC.` : "No station timestamps reported.",
|
|
142
|
-
...ranked.slice(0, limit).map((s, i) => `${i + 1}. ${s.name ?? "?"} | bikes ${s.free_bikes ?? 0} | slots ${s.empty_slots ?? 0}` +
|
|
143
|
-
` | ${Number(s.latitude ?? 0).toFixed(5)}, ${Number(s.longitude ?? 0).toFixed(5)}` +
|
|
144
|
-
`${s.extra?.ebikes != null ? ` | e-bikes ${s.extra.ebikes}` : ""} | station id ${s.id ?? "?"}`),
|
|
145
|
-
].join("\n");
|
|
146
|
-
}
|
|
147
67
|
export async function networkCapacity(args) {
|
|
148
68
|
const id = (args.network ?? "").trim();
|
|
149
69
|
if (!id)
|
package/dist/server.js
CHANGED
|
@@ -1,8 +1,6 @@
|
|
|
1
1
|
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
|
2
2
|
import { z } from "zod";
|
|
3
|
-
import { network } from "./api.js";
|
|
4
|
-
import { networks, networkSearch, stationSearch, networkCapacity } from "./api.js";
|
|
5
|
-
import { premiumRequired } from "./license.js";
|
|
3
|
+
import { network, networks, networkCapacity } from "./api.js";
|
|
6
4
|
const text = (value) => ({ content: [{ type: "text", text: value }] });
|
|
7
5
|
const textError = (t) => ({ content: [{ type: "text", text: t }], isError: true });
|
|
8
6
|
const READ_ONLY = { readOnlyHint: true, openWorldHint: true };
|
|
@@ -19,7 +17,7 @@ export function createServer() {
|
|
|
19
17
|
return text(await networks(args));
|
|
20
18
|
}
|
|
21
19
|
catch (e) {
|
|
22
|
-
return textError(
|
|
20
|
+
return textError(String(e));
|
|
23
21
|
}
|
|
24
22
|
});
|
|
25
23
|
server.registerTool("network", {
|
|
@@ -32,7 +30,7 @@ export function createServer() {
|
|
|
32
30
|
return text(await network(args));
|
|
33
31
|
}
|
|
34
32
|
catch (e) {
|
|
35
|
-
return textError(
|
|
33
|
+
return textError(String(e));
|
|
36
34
|
}
|
|
37
35
|
});
|
|
38
36
|
server.registerTool("network_search", {
|
|
@@ -41,16 +39,12 @@ export function createServer() {
|
|
|
41
39
|
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() }),
|
|
42
40
|
annotations: READ_ONLY,
|
|
43
41
|
}, async (args) => {
|
|
44
|
-
//
|
|
45
|
-
const paywallMessage = await premiumRequired("network_search");
|
|
46
|
-
if (paywallMessage)
|
|
47
|
-
return { content: [{ type: "text", text: paywallMessage }], isError: true };
|
|
48
|
-
// ---- paywall: end ----
|
|
42
|
+
// TODO: implement search locally (paywall removed)
|
|
49
43
|
try {
|
|
50
|
-
return
|
|
44
|
+
return textError("Not yet implemented: search");
|
|
51
45
|
}
|
|
52
46
|
catch (e) {
|
|
53
|
-
return textError(
|
|
47
|
+
return textError(String(e));
|
|
54
48
|
}
|
|
55
49
|
});
|
|
56
50
|
server.registerTool("station_search", {
|
|
@@ -59,16 +53,12 @@ export function createServer() {
|
|
|
59
53
|
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() }),
|
|
60
54
|
annotations: READ_ONLY,
|
|
61
55
|
}, async (args) => {
|
|
62
|
-
//
|
|
63
|
-
const paywallMessage = await premiumRequired("station_search");
|
|
64
|
-
if (paywallMessage)
|
|
65
|
-
return { content: [{ type: "text", text: paywallMessage }], isError: true };
|
|
66
|
-
// ---- paywall: end ----
|
|
56
|
+
// TODO: implement search locally (paywall removed)
|
|
67
57
|
try {
|
|
68
|
-
return
|
|
58
|
+
return textError("Not yet implemented: search");
|
|
69
59
|
}
|
|
70
60
|
catch (e) {
|
|
71
|
-
return textError(
|
|
61
|
+
return textError(String(e));
|
|
72
62
|
}
|
|
73
63
|
});
|
|
74
64
|
server.registerTool("network_capacity", {
|
package/package.json
CHANGED
package/dist/license.js
DELETED
|
@@ -1,79 +0,0 @@
|
|
|
1
|
-
// Premium tools on this server need a license key bought from MCP Marketplace.
|
|
2
|
-
// Buyers put the key in their MCP client config as MCP_LICENSE_KEY. Every tool
|
|
3
|
-
// that is not listed in PREMIUM keeps working without a key.
|
|
4
|
-
const SLUG = "citybikes-mcp";
|
|
5
|
-
// Tools that need a key. Everything else is free.
|
|
6
|
-
const PREMIUM = new Set([
|
|
7
|
-
"network_search",
|
|
8
|
-
"station_search",
|
|
9
|
-
]);
|
|
10
|
-
const BUY_URL = `https://mcp-marketplace.io/server/io-github-mrfentmen-${SLUG}`;
|
|
11
|
-
// The license check calls the marketplace's verify endpoint directly instead of
|
|
12
|
-
// using @mcp_marketplace/license. That SDK sends no `apikey` header, so every
|
|
13
|
-
// check it makes is rejected by Supabase before it reaches the function. The
|
|
14
|
-
// publishable key below is public by design - it ships in mcp-marketplace.io's
|
|
15
|
-
// own JavaScript and only ever reaches their licence check.
|
|
16
|
-
const DEFAULT_VERIFY_URL = "https://virupvwhtkpkjsiskckg.supabase.co/functions/v1/verify-key";
|
|
17
|
-
const PUBLISHABLE_KEY = "sb_publishable_BuqlW96Ke8C_zzJG-LQv1Q_YHi_r_4h";
|
|
18
|
-
const OK_CACHE_MS = 60 * 60 * 1000;
|
|
19
|
-
const BAD_CACHE_MS = 60 * 1000;
|
|
20
|
-
const seen = new Map();
|
|
21
|
-
const REASONS = {
|
|
22
|
-
missing_key: "no key is set",
|
|
23
|
-
invalid_format: "that key is not a valid MCP Marketplace key",
|
|
24
|
-
not_found: "that key was not found",
|
|
25
|
-
revoked: "that key has been revoked",
|
|
26
|
-
rotated: "that key was rotated, use your new one",
|
|
27
|
-
expired: "that key has expired, renew it",
|
|
28
|
-
rate_limited: "there were too many checks just now, try again shortly",
|
|
29
|
-
network_error: "the license server could not be reached",
|
|
30
|
-
};
|
|
31
|
-
function blocked(tool, reason) {
|
|
32
|
-
const why = REASONS[reason] ?? `the license server answered "${reason}"`;
|
|
33
|
-
return `"${tool}" needs a license key, but ${why}. ` +
|
|
34
|
-
`Set MCP_LICENSE_KEY in your MCP client config. Get a key: ${BUY_URL}`;
|
|
35
|
-
}
|
|
36
|
-
async function verify(key) {
|
|
37
|
-
const res = await fetch(process.env.MCP_LICENSE_VERIFY_URL || DEFAULT_VERIFY_URL, {
|
|
38
|
-
method: "POST",
|
|
39
|
-
headers: {
|
|
40
|
-
apikey: PUBLISHABLE_KEY,
|
|
41
|
-
Authorization: `Bearer ${PUBLISHABLE_KEY}`,
|
|
42
|
-
"Content-Type": "application/json",
|
|
43
|
-
},
|
|
44
|
-
body: JSON.stringify({ key, slug: SLUG }),
|
|
45
|
-
// an unusable key answers 400 with a JSON body, so read the body either way
|
|
46
|
-
signal: AbortSignal.timeout(15000),
|
|
47
|
-
});
|
|
48
|
-
const data = (await res.json());
|
|
49
|
-
if (typeof data?.valid !== "boolean")
|
|
50
|
-
return { valid: false, reason: "unexpected_response" };
|
|
51
|
-
return data;
|
|
52
|
-
}
|
|
53
|
-
/**
|
|
54
|
-
* Returns null when the caller may run the tool, or a short message telling
|
|
55
|
-
* them how to get a key.
|
|
56
|
-
*
|
|
57
|
-
* A good key is remembered for an hour, so a busy session does not hit the
|
|
58
|
-
* license server on every call and keeps working through a brief outage.
|
|
59
|
-
*/
|
|
60
|
-
export async function premiumRequired(tool) {
|
|
61
|
-
if (!PREMIUM.has(tool))
|
|
62
|
-
return null;
|
|
63
|
-
const key = process.env.MCP_LICENSE_KEY;
|
|
64
|
-
if (!key)
|
|
65
|
-
return blocked(tool, "missing_key");
|
|
66
|
-
const hit = seen.get(key);
|
|
67
|
-
if (hit && Date.now() - hit.at < (hit.valid ? OK_CACHE_MS : BAD_CACHE_MS)) {
|
|
68
|
-
return hit.valid ? null : blocked(tool, hit.reason ?? "invalid");
|
|
69
|
-
}
|
|
70
|
-
let result;
|
|
71
|
-
try {
|
|
72
|
-
result = await verify(key);
|
|
73
|
-
}
|
|
74
|
-
catch {
|
|
75
|
-
result = { valid: false, reason: "network_error" };
|
|
76
|
-
}
|
|
77
|
-
seen.set(key, { ...result, at: Date.now() });
|
|
78
|
-
return result.valid ? null : blocked(tool, result.reason ?? "invalid");
|
|
79
|
-
}
|