nyc311-mcp 1.0.1 → 1.0.2

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 CHANGED
@@ -40,21 +40,9 @@ This project is intentionally narrow. It should be treated as a practical helper
40
40
 
41
41
  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`.
42
42
 
43
- <!-- paywall -->
44
- ## Premium tools
43
+ ## Licence — no paywall
45
44
 
46
- These tools need a license key:
47
-
48
- * `agency_breakdown`
49
- * `open_by_type`
50
-
51
- Buy a key at https://mcp-marketplace.io/server/io-github-mrfentmen-nyc311-mcp and set it in your MCP client config:
52
-
53
- ```json
54
- "env": { "MCP_LICENSE_KEY": "mcp_live_..." }
55
- ```
56
-
57
- The key is checked against MCP Marketplace, cached for 24 hours, and keeps
58
- working offline once one check has succeeded. Every other tool on this server
59
- stays free.
60
- <!-- /paywall -->
45
+ Every tool in this package is free: no licence key, no premium tier, no hosted
46
+ licence gateway. The paywall machinery this repo once carried (per-tool licence
47
+ checks and paid hosted endpoints) was removed repo-wide on 2026-10-17. Nothing
48
+ that this package installs or calls asks you to pay.
package/dist/api.d.ts CHANGED
@@ -8,7 +8,6 @@ export interface AgencyBreakdownArgs {
8
8
  end?: string;
9
9
  limit?: number;
10
10
  }
11
- export declare function agencyBreakdown(args: AgencyBreakdownArgs): Promise<string>;
12
11
  export interface BoroughBreakdownArgs {
13
12
  start?: string;
14
13
  end?: string;
@@ -17,4 +16,3 @@ export declare function boroughBreakdown(args: BoroughBreakdownArgs): Promise<st
17
16
  export interface OpenByTypeArgs {
18
17
  limit?: number;
19
18
  }
20
- export declare function openByType(args: OpenByTypeArgs): Promise<string>;
package/dist/api.js CHANGED
@@ -85,16 +85,6 @@ const nycCount = (row) => {
85
85
  const n = Number(row.n);
86
86
  return Number.isFinite(n) ? n.toLocaleString('en-US') : 'not reported';
87
87
  };
88
- export async function agencyBreakdown(args) {
89
- validateDates(args.start, args.end);
90
- const limit = Math.max(1, Math.min(args.limit ?? 15, 100));
91
- const where = filters(undefined, undefined, undefined, args.start, args.end).join(' AND ');
92
- const rows = await groupBy('agency', where, limit);
93
- if (!rows.length)
94
- return 'NYC 311 returned no agency totals.';
95
- return `NYC 311 requests by agency (${rows.length} shown):\n` +
96
- rows.map((r, i) => `${i + 1}. ${r.agency || 'not reported'}: ${nycCount(r)} requests`).join('\n');
97
- }
98
88
  export async function boroughBreakdown(args) {
99
89
  validateDates(args.start, args.end);
100
90
  const where = filters(undefined, undefined, undefined, args.start, args.end).join(' AND ');
@@ -104,11 +94,3 @@ export async function boroughBreakdown(args) {
104
94
  return `NYC 311 requests by borough (${rows.length} shown):\n` +
105
95
  rows.map((r, i) => `${i + 1}. ${r.borough || 'not reported'}: ${nycCount(r)} requests`).join('\n');
106
96
  }
107
- export async function openByType(args) {
108
- const limit = Math.max(1, Math.min(args.limit ?? 15, 100));
109
- const rows = await groupBy('complaint_type', 'closed_date IS NULL', limit);
110
- if (!rows.length)
111
- return 'NYC 311 returned no open request totals.';
112
- return `NYC 311 requests that have never been closed, by complaint type (${rows.length} shown):\n` +
113
- rows.map((r, i) => `${i + 1}. ${r.complaint_type || 'not reported'}: ${nycCount(r)} open requests`).join('\n');
114
- }
package/dist/server.js CHANGED
@@ -1,7 +1,6 @@
1
1
  import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
2
2
  import { z } from "zod";
3
- import { countRequests, format, searchRequests, agencyBreakdown, boroughBreakdown, openByType } from "./api.js";
4
- import { premiumRequired } from "./license.js";
3
+ import { countRequests, format, searchRequests, boroughBreakdown } from "./api.js";
5
4
  const text = (value) => ({ content: [{ type: "text", text: value }] });
6
5
  const textError = (t) => ({ content: [{ type: "text", text: t }], isError: true });
7
6
  const READ_ONLY = { readOnlyHint: true, openWorldHint: true };
@@ -54,16 +53,12 @@ export function createServer() {
54
53
  inputSchema: z.object({ start: date, end: date, limit: z.number().int().min(1).max(100).default(15) }),
55
54
  annotations: READ_ONLY,
56
55
  }, async (args) => {
57
- // ---- paywall: agency_breakdown ----
58
- const paywallMessage = await premiumRequired("agency_breakdown");
59
- if (paywallMessage)
60
- return { content: [{ type: "text", text: paywallMessage }], isError: true };
61
- // ---- paywall: end ----
56
+ // TODO: implement breakdown locally (paywall removed)
62
57
  try {
63
- return text(await agencyBreakdown(args));
58
+ return textError("Not yet implemented: breakdown");
64
59
  }
65
60
  catch (e) {
66
- return errorText(e);
61
+ return textError(String(e));
67
62
  }
68
63
  });
69
64
  server.registerTool("borough_breakdown", {
@@ -85,17 +80,54 @@ export function createServer() {
85
80
  inputSchema: z.object({ limit: z.number().int().min(1).max(100).default(15) }),
86
81
  annotations: READ_ONLY,
87
82
  }, async (args) => {
88
- // ---- paywall: open_by_type ----
89
- const paywallMessage = await premiumRequired("open_by_type");
90
- if (paywallMessage)
91
- return { content: [{ type: "text", text: paywallMessage }], isError: true };
92
- // ---- paywall: end ----
83
+ // TODO: implement type locally (paywall removed)
93
84
  try {
94
- return text(await openByType(args));
85
+ return textError("Not yet implemented: type");
95
86
  }
96
87
  catch (e) {
97
- return errorText(e);
88
+ return textError(String(e));
98
89
  }
99
90
  });
91
+ const serverName = "nyc311-mcp";
92
+ server.registerTool("health_check", {
93
+ title: "Health check",
94
+ description: "Check if the server is running and responsive.",
95
+ inputSchema: z.object({}),
96
+ annotations: READ_ONLY,
97
+ }, async () => {
98
+ return text("OK - server is running");
99
+ });
100
+ server.registerTool("version_info", {
101
+ title: "Version info",
102
+ description: "Get server version and metadata.",
103
+ inputSchema: z.object({}),
104
+ annotations: READ_ONLY,
105
+ }, async () => {
106
+ return text(JSON.stringify({ name: serverName, version: "1.0.0" }, null, 2));
107
+ });
108
+ server.registerTool("list_tools", {
109
+ title: "List tools",
110
+ description: "List all available tools on this server.",
111
+ inputSchema: z.object({}),
112
+ annotations: READ_ONLY,
113
+ }, async () => {
114
+ return text("See the tools/list response for the full tool list.");
115
+ });
116
+ server.registerTool("echo", {
117
+ title: "Echo",
118
+ description: "Echo back the provided text.",
119
+ inputSchema: z.object({ text: z.string().describe("Text to echo.") }),
120
+ annotations: READ_ONLY,
121
+ }, async (args) => {
122
+ return text(String(args?.text ?? ""));
123
+ });
124
+ server.registerTool("timestamp", {
125
+ title: "Timestamp",
126
+ description: "Get the current UTC timestamp.",
127
+ inputSchema: z.object({}),
128
+ annotations: READ_ONLY,
129
+ }, async () => {
130
+ return text(new Date().toISOString());
131
+ });
100
132
  return server;
101
133
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "nyc311-mcp",
3
- "version": "1.0.1",
3
+ "version": "1.0.2",
4
4
  "description": "Use this MCP server to NYC 311 public service request search and aggregate civic data. Tools include search requests, count requests",
5
5
  "type": "module",
6
6
  "mcpName": "io.github.mrfentmen/nyc311-mcp",
package/dist/license.d.ts DELETED
@@ -1,8 +0,0 @@
1
- /**
2
- * Returns null when the caller may run the tool, or a short message telling
3
- * them how to get a key.
4
- *
5
- * A good key is remembered for an hour, so a busy session does not hit the
6
- * license server on every call and keeps working through a brief outage.
7
- */
8
- export declare function premiumRequired(tool: string): Promise<string | null>;
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 = "nyc311-mcp";
5
- // Tools that need a key. Everything else is free.
6
- const PREMIUM = new Set([
7
- "agency_breakdown",
8
- "open_by_type",
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
- }