zip-codes-mcp 1.0.0 → 1.0.1

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
@@ -19,3 +19,21 @@ node dist/index.js
19
19
  ```
20
20
 
21
21
  Data comes from the public Zippopotam API.
22
+
23
+ <!-- paywall -->
24
+ ## Premium tools
25
+
26
+ These tools need a license key:
27
+
28
+ * `reverse_geocode`
29
+
30
+ Buy a key at https://mcp-marketplace.io/server/io-github-mrfentmen-zip-codes-mcp and set it in your MCP client config:
31
+
32
+ ```json
33
+ "env": { "MCP_LICENSE_KEY": "mcp_live_..." }
34
+ ```
35
+
36
+ The key is checked against MCP Marketplace, cached for 24 hours, and keeps
37
+ working offline once one check has succeeded. Every other tool on this server
38
+ stays free.
39
+ <!-- /paywall -->
package/dist/api.js CHANGED
@@ -33,3 +33,41 @@ export async function cityLookup(args) {
33
33
  const zips = [...new Set(places.map((p) => p?.["post code"]).filter(Boolean))];
34
34
  return `${city[0].toUpperCase()}${city.slice(1)}, ${state.toUpperCase()}\nZip codes: ${zips.join(", ")}`;
35
35
  }
36
+ // ---- muxB tools:
37
+ const NOMINATIM = "https://nominatim.openstreetmap.org/reverse";
38
+ export async function reverseGeocode(args) {
39
+ const lat = Number(args.latitude);
40
+ const lon = Number(args.longitude);
41
+ if (!Number.isFinite(lat) || lat < -90 || lat > 90)
42
+ throw new ZipError("Provide a latitude between -90 and 90");
43
+ if (!Number.isFinite(lon) || lon < -180 || lon > 180)
44
+ throw new ZipError("Provide a longitude between -180 and 180");
45
+ const params = new URLSearchParams({ format: "jsonv2", lat: String(lat), lon: String(lon), zoom: "14" });
46
+ const res = await fetch(`${NOMINATIM}?${params.toString()}`, {
47
+ headers: { "User-Agent": UA, Accept: "application/json" },
48
+ signal: AbortSignal.timeout(25000),
49
+ });
50
+ if (res.status === 429)
51
+ throw new ZipError("Reverse geocoder rate limit hit, wait and retry");
52
+ if (!res.ok)
53
+ throw new ZipError(`Reverse geocoder error ${res.status}`);
54
+ const d = (await res.json());
55
+ const a = d.address ?? {};
56
+ const field = (keys) => {
57
+ for (const k of keys) {
58
+ const v = a[k];
59
+ if (v)
60
+ return v;
61
+ }
62
+ return "not reported";
63
+ };
64
+ return [
65
+ `Reverse geocode of ${lat}, ${lon} (OpenStreetMap Nominatim)`,
66
+ `Post code: ${field(["postcode"])}`,
67
+ `City or town: ${field(["city", "town", "village", "municipality", "hamlet", "suburb"])}`,
68
+ `State or region: ${field(["state", "region", "province"])}`,
69
+ `Country: ${field(["country"])} (${field(["country_code"])})`,
70
+ `Matched feature: ${d.type ?? "not reported"}`,
71
+ `Full address: ${d.display_name ?? "not reported"}`,
72
+ ].join("\n");
73
+ }
@@ -0,0 +1,78 @@
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 = "zip-codes-mcp";
5
+ // Tools that need a key. Everything else is free.
6
+ const PREMIUM = new Set([
7
+ "reverse_geocode",
8
+ ]);
9
+ const BUY_URL = `https://mcp-marketplace.io/server/io-github-mrfentmen-${SLUG}`;
10
+ // The license check calls the marketplace's verify endpoint directly instead of
11
+ // using @mcp_marketplace/license. That SDK sends no `apikey` header, so every
12
+ // check it makes is rejected by Supabase before it reaches the function. The
13
+ // publishable key below is public by design - it ships in mcp-marketplace.io's
14
+ // own JavaScript and only ever reaches their licence check.
15
+ const DEFAULT_VERIFY_URL = "https://virupvwhtkpkjsiskckg.supabase.co/functions/v1/verify-key";
16
+ const PUBLISHABLE_KEY = "sb_publishable_BuqlW96Ke8C_zzJG-LQv1Q_YHi_r_4h";
17
+ const OK_CACHE_MS = 60 * 60 * 1000;
18
+ const BAD_CACHE_MS = 60 * 1000;
19
+ const seen = new Map();
20
+ const REASONS = {
21
+ missing_key: "no key is set",
22
+ invalid_format: "that key is not a valid MCP Marketplace key",
23
+ not_found: "that key was not found",
24
+ revoked: "that key has been revoked",
25
+ rotated: "that key was rotated, use your new one",
26
+ expired: "that key has expired, renew it",
27
+ rate_limited: "there were too many checks just now, try again shortly",
28
+ network_error: "the license server could not be reached",
29
+ };
30
+ function blocked(tool, reason) {
31
+ const why = REASONS[reason] ?? `the license server answered "${reason}"`;
32
+ return `"${tool}" needs a license key, but ${why}. ` +
33
+ `Set MCP_LICENSE_KEY in your MCP client config. Get a key: ${BUY_URL}`;
34
+ }
35
+ async function verify(key) {
36
+ const res = await fetch(process.env.MCP_LICENSE_VERIFY_URL || DEFAULT_VERIFY_URL, {
37
+ method: "POST",
38
+ headers: {
39
+ apikey: PUBLISHABLE_KEY,
40
+ Authorization: `Bearer ${PUBLISHABLE_KEY}`,
41
+ "Content-Type": "application/json",
42
+ },
43
+ body: JSON.stringify({ key, slug: SLUG }),
44
+ // an unusable key answers 400 with a JSON body, so read the body either way
45
+ signal: AbortSignal.timeout(15000),
46
+ });
47
+ const data = (await res.json());
48
+ if (typeof data?.valid !== "boolean")
49
+ return { valid: false, reason: "unexpected_response" };
50
+ return data;
51
+ }
52
+ /**
53
+ * Returns null when the caller may run the tool, or a short message telling
54
+ * them how to get a key.
55
+ *
56
+ * A good key is remembered for an hour, so a busy session does not hit the
57
+ * license server on every call and keeps working through a brief outage.
58
+ */
59
+ export async function premiumRequired(tool) {
60
+ if (!PREMIUM.has(tool))
61
+ return null;
62
+ const key = process.env.MCP_LICENSE_KEY;
63
+ if (!key)
64
+ return blocked(tool, "missing_key");
65
+ const hit = seen.get(key);
66
+ if (hit && Date.now() - hit.at < (hit.valid ? OK_CACHE_MS : BAD_CACHE_MS)) {
67
+ return hit.valid ? null : blocked(tool, hit.reason ?? "invalid");
68
+ }
69
+ let result;
70
+ try {
71
+ result = await verify(key);
72
+ }
73
+ catch {
74
+ result = { valid: false, reason: "network_error" };
75
+ }
76
+ seen.set(key, { ...result, at: Date.now() });
77
+ return result.valid ? null : blocked(tool, result.reason ?? "invalid");
78
+ }
package/dist/server.js CHANGED
@@ -1,7 +1,8 @@
1
1
  import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
2
2
  import { z } from "zod";
3
3
  import { cityLookup } from "./api.js";
4
- import { zipLookup } from "./api.js";
4
+ import { zipLookup, reverseGeocode } from "./api.js";
5
+ import { premiumRequired } from "./license.js";
5
6
  const text = (value) => ({ content: [{ type: "text", text: value }] });
6
7
  const textError = (t) => ({ content: [{ type: "text", text: t }], isError: true });
7
8
  const READ_ONLY = { readOnlyHint: true, openWorldHint: true };
@@ -34,5 +35,23 @@ export function createServer() {
34
35
  return textError(error(e));
35
36
  }
36
37
  });
38
+ server.registerTool("reverse_geocode", {
39
+ title: "Reverse geocode",
40
+ description: "Turn a latitude and longitude into the post code, city, state and country that OpenStreetMap Nominatim has for that point.",
41
+ inputSchema: z.object({ latitude: z.number().describe("Latitude, -90 to 90."), longitude: z.number().describe("Longitude, -180 to 180.") }),
42
+ annotations: READ_ONLY,
43
+ }, async (args) => {
44
+ // ---- paywall: reverse_geocode ----
45
+ const paywallMessage = await premiumRequired("reverse_geocode");
46
+ if (paywallMessage)
47
+ return { content: [{ type: "text", text: paywallMessage }], isError: true };
48
+ // ---- paywall: end ----
49
+ try {
50
+ return text(await reverseGeocode(args));
51
+ }
52
+ catch (e) {
53
+ return textError(error(e));
54
+ }
55
+ });
37
56
  return server;
38
57
  }
package/package.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "1.0.0",
2
+ "version": "1.0.1",
3
3
  "type": "module",
4
4
  "repository": {
5
5
  "type": "git",