nyc311-mcp 1.0.0 → 1.0.1

package/README.md

@@ -39,3 +39,22 @@ This project is intentionally narrow. It should be treated as a practical helper
 ## Try it
 
 After building, connect the server through your MCP client. The repository root also contains `smoke-test.mjs` for projects covered by the shared harness. A typical tool call starts with `search_requests`.
+
+<!-- paywall -->
+## Premium tools
+
+These tools need a license key:
+
+* `agency_breakdown`
+* `open_by_type`
+
+Buy a key at https://mcp-marketplace.io/server/io-github-mrfentmen-nyc311-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

@@ -3,3 +3,18 @@ export declare class Nyc311Error extends Error {
 export declare function searchRequests(complaintType?: string, borough?: string, agency?: string, start?: string, end?: string, limit?: number): Promise<unknown>;
 export declare function countRequests(complaintType?: string, borough?: string, agency?: string, start?: string, end?: string, limit?: number): Promise<unknown>;
 export declare function format(value: unknown): string;
+export interface AgencyBreakdownArgs {
+    start?: string;
+    end?: string;
+    limit?: number;
+}
+export declare function agencyBreakdown(args: AgencyBreakdownArgs): Promise<string>;
+export interface BoroughBreakdownArgs {
+    start?: string;
+    end?: string;
+}
+export declare function boroughBreakdown(args: BoroughBreakdownArgs): Promise<string>;
+export interface OpenByTypeArgs {
+    limit?: number;
+}
+export declare function openByType(args: OpenByTypeArgs): Promise<string>;

package/dist/api.js

@@ -62,3 +62,53 @@ export function countRequests(complaintType, borough, agency, start, end, limit
     });
 }
 export function format(value) { return JSON.stringify(value, null, 2).slice(0, 16000); }
+// ---- muxB tools:
+// aggregation only: the existing tools deliberately keep addresses and
+// coordinates out of the response, so these do too
+async function groupBy(column, where, limit) {
+    const params = {
+        $select: `${column},count(*) as n`,
+        $group: column,
+        $order: 'n DESC',
+        $limit: String(limit),
+    };
+    if (where)
+        params.$where = where;
+    const url = new URL(BASE);
+    Object.entries(params).forEach(([key, value]) => url.searchParams.set(key, value));
+    const response = await fetch(url, { headers: HEADERS, signal: AbortSignal.timeout(30000) });
+    if (!response.ok)
+        throw new Nyc311Error(`NYC 311 error ${response.status}`);
+    return (await response.json());
+}
+const nycCount = (row) => {
+    const n = Number(row.n);
+    return Number.isFinite(n) ? n.toLocaleString('en-US') : 'not reported';
+};
+export async function agencyBreakdown(args) {
+    validateDates(args.start, args.end);
+    const limit = Math.max(1, Math.min(args.limit ?? 15, 100));
+    const where = filters(undefined, undefined, undefined, args.start, args.end).join(' AND ');
+    const rows = await groupBy('agency', where, limit);
+    if (!rows.length)
+        return 'NYC 311 returned no agency totals.';
+    return `NYC 311 requests by agency (${rows.length} shown):\n` +
+        rows.map((r, i) => `${i + 1}. ${r.agency || 'not reported'}: ${nycCount(r)} requests`).join('\n');
+}
+export async function boroughBreakdown(args) {
+    validateDates(args.start, args.end);
+    const where = filters(undefined, undefined, undefined, args.start, args.end).join(' AND ');
+    const rows = await groupBy('borough', where, 6);
+    if (!rows.length)
+        return 'NYC 311 returned no borough totals.';
+    return `NYC 311 requests by borough (${rows.length} shown):\n` +
+        rows.map((r, i) => `${i + 1}. ${r.borough || 'not reported'}: ${nycCount(r)} requests`).join('\n');
+}
+export async function openByType(args) {
+    const limit = Math.max(1, Math.min(args.limit ?? 15, 100));
+    const rows = await groupBy('complaint_type', 'closed_date IS NULL', limit);
+    if (!rows.length)
+        return 'NYC 311 returned no open request totals.';
+    return `NYC 311 requests that have never been closed, by complaint type (${rows.length} shown):\n` +
+        rows.map((r, i) => `${i + 1}. ${r.complaint_type || 'not reported'}: ${nycCount(r)} open requests`).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 = "nyc311-mcp";
+// Tools that need a key. Everything else is free.
+const PREMIUM = new Set([
+    "agency_breakdown",
+    "open_by_type",
+]);
+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 { countRequests, format, searchRequests } from "./api.js";
+import { countRequests, format, searchRequests, agencyBreakdown, boroughBreakdown, openByType } 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 };
@@ -47,5 +48,54 @@ export function createServer() {
             return errorText(error);
         }
     });
+    server.registerTool("agency_breakdown", {
+        title: "Agency breakdown",
+        description: "Count NYC 311 requests grouped by the agency that received them, with an optional date range.",
+        inputSchema: z.object({ start: date, end: date, limit: z.number().int().min(1).max(100).default(15) }),
+        annotations: READ_ONLY,
+    }, async (args) => {
+        // ---- paywall: agency_breakdown ----
+        const paywallMessage = await premiumRequired("agency_breakdown");
+        if (paywallMessage)
+            return { content: [{ type: "text", text: paywallMessage }], isError: true };
+        // ---- paywall: end ----
+        try {
+            return text(await agencyBreakdown(args));
+        }
+        catch (e) {
+            return errorText(e);
+        }
+    });
+    server.registerTool("borough_breakdown", {
+        title: "Borough breakdown",
+        description: "Count NYC 311 requests grouped by borough, with an optional date range.",
+        inputSchema: z.object({ start: date, end: date }),
+        annotations: READ_ONLY,
+    }, async (args) => {
+        try {
+            return text(await boroughBreakdown(args));
+        }
+        catch (e) {
+            return errorText(e);
+        }
+    });
+    server.registerTool("open_by_type", {
+        title: "Open by type",
+        description: "Which NYC 311 complaint types have the most requests that were never closed.",
+        inputSchema: z.object({ limit: z.number().int().min(1).max(100).default(15) }),
+        annotations: READ_ONLY,
+    }, async (args) => {
+        // ---- paywall: open_by_type ----
+        const paywallMessage = await premiumRequired("open_by_type");
+        if (paywallMessage)
+            return { content: [{ type: "text", text: paywallMessage }], isError: true };
+        // ---- paywall: end ----
+        try {
+            return text(await openByType(args));
+        }
+        catch (e) {
+            return errorText(e);
+        }
+    });
     return server;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nyc311-mcp",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Use this MCP server to NYC 311 public service request search and aggregate civic data. Tools include search requests, count requests",
   "type": "module",
   "mcpName": "io.github.mrfentmen/nyc311-mcp",