tdx-mcp 1.0.0 → 1.0.1

package/README.md

@@ -18,3 +18,22 @@ Needs free TDX client id + secret (TDX_CLIENT_SECRET) from tdx.transportdata.tw.
 - `get_tra_timetable` — Taiwan Railway daily timetable for a station on a date.
 
 Part of [awesome-mcps](https://github.com/mrfentmen/awesome-mcps).
+
+<!-- paywall -->
+## Premium tools
+
+These tools need a license key:
+
+* `ods_train_departures`
+* `ods_train_route`
+
+Buy a key at https://mcp-marketplace.io/server/io-github-mrfentmen-tdx-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.d.ts

@@ -6,3 +6,16 @@ export declare function listTraStations(): Promise<string>;
 export declare function getTraLiveboard(stationId: string): Promise<string>;
 export declare function listThsrStations(): Promise<string>;
 export declare function getTraTimetable(stationId: string, date: string): Promise<string>;
+export declare function odsStationSearch(args: {
+    query: string;
+    limit?: number;
+}): Promise<string>;
+export declare function odsTrainDepartures(args: {
+    stationId: string;
+    date?: string;
+    limit?: number;
+}): Promise<string>;
+export declare function odsTrainRoute(args: {
+    trainNumber: string;
+    date?: string;
+}): Promise<string>;

package/dist/api.js

@@ -97,3 +97,175 @@ export async function getTraTimetable(stationId, date) {
     const data = await req(url);
     return pretty(data);
 }
+// ---- muxB tools:
+// Taiwan Railway's own Open Data System (ods.railway.gov.tw) publishes the
+// station list and a rolling window of daily timetables with no key at all.
+// These two URLs are the download links data.gov.tw points at for datasets
+// 33425 (station basic data) and the daily timetable.
+const ODS_BASE = "https://ods.railway.gov.tw/tra-ods-web/ods/download/dataResource";
+const ODS_STATIONS = `${ODS_BASE}/0518b833e8964d53bfea3f7691aea0ee`;
+const ODS_TIMETABLE_INDEX = `${ODS_BASE}/railway_schedule/JSON/list`;
+let stationCache = null;
+let timetableIndex = null;
+async function odsFetch(url, timeout = 30000) {
+    const res = await fetch(url, {
+        headers: { ...UA, Accept: "application/json, text/html" },
+        signal: AbortSignal.timeout(timeout),
+    });
+    if (res.status === 404)
+        throw new TdxError(`Taiwan Railway Open Data has nothing at ${url}`);
+    if (!res.ok)
+        throw new TdxError(`Taiwan Railway Open Data returned HTTP ${res.status}`);
+    return (await res.json());
+}
+async function getStations() {
+    if (stationCache)
+        return stationCache;
+    const rows = await odsFetch(ODS_STATIONS);
+    const map = new Map();
+    for (const s of Array.isArray(rows) ? rows : []) {
+        if (s.stationCode)
+            map.set(String(s.stationCode), `${String(s.stationName ?? "")} ${String(s.stationEName ?? "")}`.trim());
+    }
+    if (map.size === 0)
+        throw new TdxError("The station dataset came back empty.");
+    stationCache = map;
+    return map;
+}
+async function getTimetableIndex() {
+    if (timetableIndex)
+        return timetableIndex;
+    const res = await fetch(ODS_TIMETABLE_INDEX, { headers: { ...UA }, signal: AbortSignal.timeout(30000) });
+    if (!res.ok)
+        throw new TdxError(`The TRA timetable index returned HTTP ${res.status}`);
+    const html = await res.text();
+    const out = [];
+    for (const m of html.matchAll(/<a href="([^"]+)">(\d{8})\.json<\/a>/g)) {
+        out.push({ date: m[2], url: `https://ods.railway.gov.tw${m[1]}` });
+    }
+    if (!out.length)
+        throw new TdxError("The TRA timetable index listed no daily JSON files.");
+    out.sort((a, b) => b.date.localeCompare(a.date));
+    timetableIndex = out;
+    return out;
+}
+function requireDate(date) {
+    const d = (date ?? "").trim();
+    if (!/^\d{8}$/.test(d))
+        throw new TdxError(`Date must be YYYYMMDD, e.g. 20260928, got "${date ?? ""}".`);
+    return d;
+}
+// The index carries a rolling window of daily timetables, so with no date given
+// pick the one closest to today rather than blindly the last one published.
+function nearestDate(index) {
+    const today = new Date().toISOString().slice(0, 10).replace(/-/g, "");
+    let best = index[0].date;
+    let bestGap = Number.MAX_SAFE_INTEGER;
+    for (const row of index) {
+        const gap = Math.abs(Number(row.date) - Number(today));
+        if (gap < bestGap) {
+            bestGap = gap;
+            best = row.date;
+        }
+    }
+    return best;
+}
+function clock(value) {
+    return typeof value === "string" && value ? value.slice(0, 5) : "--:--";
+}
+export async function odsStationSearch(args) {
+    const q = (args.query ?? "").trim().toLowerCase();
+    if (!q)
+        throw new TdxError("Search text is empty.");
+    const limit = Math.min(Math.max(args.limit ?? 8, 1), 30);
+    const rows = await odsFetch(ODS_STATIONS);
+    const list = Array.isArray(rows) ? rows : [];
+    const matches = list
+        .filter((s) => String(s.stationCode ?? "").toLowerCase().includes(q) || String(s.stationName ?? "").includes(q) || String(s.stationEName ?? "").toLowerCase().includes(q))
+        .slice(0, limit);
+    if (matches.length === 0) {
+        const sample = list.slice(0, 3).map((s) => `${s.stationCode ?? "?"} ${s.stationName ?? ""}`).join(", ");
+        return `No Taiwan Railway station matches "${args.query ?? ""}". For example: ${sample}`;
+    }
+    return [
+        `Taiwan Railway stations matching "${args.query ?? ""}" - ${matches.length} of ${list.length}, showing ${matches.length}:`,
+        ...matches.map((s, i) => {
+            const gps = String(s.gps ?? "").split(/\s+/).filter(Boolean);
+            return [
+                `${i + 1}. ${s.stationName ?? "(unnamed)"} / ${s.stationEName ?? "?"} [code ${s.stationCode ?? "?"}]`,
+                `   ${String(s.stationAddrTw ?? "address not reported")}`,
+                `   tel ${s.stationTel ?? "not reported"}${gps.length === 2 ? ` · ${gps[0]}, ${gps[1]}` : ""}${s.haveBike === "Y" ? " · bike rental" : ""}`,
+            ].join("\n");
+        }),
+    ].join("\n");
+}
+export async function odsTrainDepartures(args) {
+    const station = (args.stationId ?? "").trim();
+    if (!/^\d{4}$/.test(station))
+        throw new TdxError(`Station code must be 4 digits, e.g. 1000 for Taipei, got "${args.stationId ?? ""}".`);
+    const limit = Math.min(Math.max(args.limit ?? 12, 1), 60);
+    const index = await getTimetableIndex();
+    const wanted = (args.date ?? "").trim() ? requireDate(args.date) : nearestDate(index);
+    const entry = index.find((d) => d.date === wanted);
+    if (!entry) {
+        const range = `${index[index.length - 1].date} to ${index[0].date}`;
+        return `No Taiwan Railway timetable is published for ${wanted}. The index covers ${range}.`;
+    }
+    const names = await getStations();
+    const data = await odsFetch(entry.url, 60000);
+    const trains = Array.isArray(data.TrainInfos) ? data.TrainInfos : [];
+    const rows = [];
+    for (const t of trains) {
+        const stops = Array.isArray(t.TimeInfos) ? t.TimeInfos : [];
+        const at = stops.find((s) => String(s.Station) === station);
+        if (!at)
+            continue;
+        const order = Number(at.Order ?? 0);
+        const origin = stops[0];
+        const dest = stops[stops.length - 1];
+        rows.push(`   ${clock(at.DEPTime)}  train ${t.Train ?? "?"}  line ${t.Line ?? "?"}/${t.LineDir ?? "?"}  ${names.get(String(origin.Station)) ?? origin.Station} -> ${names.get(String(dest.Station)) ?? dest.Station}  (stop ${order} of ${stops.length})`);
+    }
+    if (!rows.length)
+        return `No train calls at station ${station} (${names.get(station) ?? "unknown"}) on ${wanted}.`;
+    rows.sort((a, b) => a.localeCompare(b));
+    return [
+        `Departures at ${names.get(station) ?? `station ${station}`} [${station}] on ${wanted} - ${rows.length} of ${trains.length} published trains, showing ${Math.min(limit, rows.length)}:`,
+        ...rows.slice(0, limit),
+        rows.length > limit ? `...and ${rows.length - limit} more, raise limit to see them.` : "",
+    ]
+        .filter(Boolean)
+        .join("\n");
+}
+export async function odsTrainRoute(args) {
+    const train = (args.trainNumber ?? "").trim();
+    if (!/^\d{1,5}$/.test(train))
+        throw new TdxError(`Train number must be digits, e.g. 1001, got "${args.trainNumber ?? ""}".`);
+    const index = await getTimetableIndex();
+    const wanted = (args.date ?? "").trim() ? requireDate(args.date) : nearestDate(index);
+    const entry = index.find((d) => d.date === wanted);
+    if (!entry) {
+        const range = `${index[index.length - 1].date} to ${index[0].date}`;
+        return `No Taiwan Railway timetable is published for ${wanted}. The index covers ${range}.`;
+    }
+    const names = await getStations();
+    const data = await odsFetch(entry.url, 60000);
+    const trains = Array.isArray(data.TrainInfos) ? data.TrainInfos : [];
+    const found = trains.find((t) => String(t.Train ?? "").trim() === train);
+    if (!found)
+        return `Train ${train} does not run on ${wanted}.`;
+    const stops = Array.isArray(found.TimeInfos) ? found.TimeInfos : [];
+    const last = stops.length - 1;
+    return [
+        `Taiwan Railway train ${train} on ${wanted} - line ${found.Line ?? "?"}, direction ${found.LineDir ?? "?"}, type ${found.Type ?? "?"}, carriage class ${found.CarClass ?? "not reported"}`,
+        `Bicycle: ${found.Bike === "Y" ? "carries bikes" : found.Bike === "N" ? "no bikes" : "not reported"} · dining: ${found.Dinning === "Y" ? "yes" : "no"} · food service: ${found.FoodSrv === "Y" ? "yes" : "no"} · accessible: ${found.Cripple === "Y" ? "yes" : "no"}`,
+        found.Note ? `Note: ${String(found.Note).slice(0, 200)}` : "",
+        stops.length ? "Stops:" : "Stops: none published",
+        ...stops.map((s, i) => {
+            const arrive = i === 0 || i === last ? clock(s.ARRTime) : clock(s.ARRTime);
+            const depart = i === last ? "(terminus)" : clock(s.DEPTime);
+            return `   ${String(s.Order ?? i + 1).padStart(2)}. ${names.get(String(s.Station)) ?? `station ${s.Station}`} [${s.Station}] arr ${arrive} dep ${depart}`;
+        }),
+    ]
+        .filter(Boolean)
+        .join("\n");
+}

package/dist/license.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 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 declare function premiumRequired(tool: string): Promise<string | null>;

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 = "tdx-mcp";
+// Tools that need a key. Everything else is free.
+const PREMIUM = new Set([
+    "ods_train_departures",
+    "ods_train_route",
+]);
+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,6 +1,7 @@
 import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { z } from "zod";
-import { errorMessage, listTraStations, getTraLiveboard, listThsrStations, getTraTimetable, } from "./api.js";
+import { errorMessage, listTraStations, getTraLiveboard, listThsrStations, getTraTimetable, odsStationSearch, odsTrainDepartures, odsTrainRoute } from "./api.js";
+import { premiumRequired } from "./license.js";
 const text = (t) => ({ content: [{ type: "text", text: t }] });
 const textError = (t) => ({ content: [{ type: "text", text: t }], isError: true });
 const READ_ONLY = { readOnlyHint: true, openWorldHint: true };
@@ -66,5 +67,64 @@ export function createServer() {
             return textError(errorMessage(e));
         }
     });
+    server.registerTool("ods_station_search", {
+        title: "Search TRA stations",
+        description: "Search Taiwan Railway stations from the rail company's open data station list: code, Chinese and English name, address, phone, GPS coordinates and bike rental.",
+        inputSchema: z.object({
+            query: z.string().describe("Station code, Chinese name or English name, e.g. '1000', 'Taipei', '板橋'"),
+            limit: z.number().int().min(1).max(30).default(8),
+        }),
+        annotations: READ_ONLY,
+    }, async ({ query, limit }) => {
+        try {
+            return text(await odsStationSearch({ query, limit }));
+        }
+        catch (e) {
+            return textError(errorMessage(e));
+        }
+    });
+    server.registerTool("ods_train_departures", {
+        title: "TRA departures board",
+        description: "Real Taiwan Railway departures for one station on one published date, from the rail company's open daily timetable: departure time, train number, line and its origin and destination.",
+        inputSchema: z.object({
+            stationId: z.string().describe("4-digit station code from ods_station_search, e.g. 1000 for Taipei"),
+            date: z.string().default("").describe("Date YYYYMMDD. Empty = newest published timetable."),
+            limit: z.number().int().min(1).max(60).default(12),
+        }),
+        annotations: READ_ONLY,
+    }, async ({ stationId, date, limit }) => {
+        // ---- paywall: ods_train_departures ----
+        const paywallMessage = await premiumRequired("ods_train_departures");
+        if (paywallMessage)
+            return { content: [{ type: "text", text: paywallMessage }], isError: true };
+        // ---- paywall: end ----
+        try {
+            return text(await odsTrainDepartures({ stationId, date, limit }));
+        }
+        catch (e) {
+            return textError(errorMessage(e));
+        }
+    });
+    server.registerTool("ods_train_route", {
+        title: "TRA train route",
+        description: "The whole run of one Taiwan Railway train on one published date: every stop with arrival and departure times and station names, plus carriage class, bike, dining and accessibility flags.",
+        inputSchema: z.object({
+            trainNumber: z.string().describe("Train number, e.g. 1001"),
+            date: z.string().default("").describe("Date YYYYMMDD. Empty = newest published timetable."),
+        }),
+        annotations: READ_ONLY,
+    }, async ({ trainNumber, date }) => {
+        // ---- paywall: ods_train_route ----
+        const paywallMessage = await premiumRequired("ods_train_route");
+        if (paywallMessage)
+            return { content: [{ type: "text", text: paywallMessage }], isError: true };
+        // ---- paywall: end ----
+        try {
+            return text(await odsTrainRoute({ trainNumber, date }));
+        }
+        catch (e) {
+            return textError(errorMessage(e));
+        }
+    });
     return server;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tdx-mcp",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Taiwan TDX transport: TRA and THSR stations, live boards, daily timetables. Needs app keys.",
   "type": "module",
   "mcpName": "io.github.mrfentmen/tdx-mcp",