zip-codes-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
@@ -23,17 +23,18 @@ Data comes from the public Zippopotam API.
23
23
  <!-- paywall -->
24
24
  ## Premium tools
25
25
 
26
- These tools need a license key:
26
+ These tools need a licence key:
27
27
 
28
28
  * `reverse_geocode`
29
+ * `address_search`
29
30
 
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
+ The tool bodies run on our gateway, not inside this package, so the key is what buys access. Buy one at https://buy.polar.sh/polar_cl_mrO7rS5LZxpqM7oAFFEA10i9121J240U40IIj4JRZO4 and set it in your MCP client config:
31
32
 
32
33
  ```json
33
- "env": { "MCP_LICENSE_KEY": "mcp_live_..." }
34
+ "env": { "MCP_LICENSE_KEY": "polar_..." }
34
35
  ```
35
36
 
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
37
+ The gateway checks the key against Polar and gives every key 1,000 free premium
38
+ calls a month before per-call billing starts. Every other tool on this server
38
39
  stays free.
39
40
  <!-- /paywall -->
package/dist/api.js CHANGED
@@ -33,41 +33,32 @@ 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");
36
+ // ---- gap4c4 tools:
37
+ export async function nearbyPostcodes(args) {
38
+ const lat = Number(args.latitude), lon = Number(args.longitude);
39
+ if (!Number.isFinite(lat) || lat < -90 || lat > 90 || !Number.isFinite(lon) || lon < -180 || lon > 180)
40
+ throw new ZipError('Provide valid latitude and longitude.');
41
+ const radius = Math.max(100, Math.min(Math.round(args.radius ?? 5000), 10000)), limit = Math.max(1, Math.min(Math.round(args.limit ?? 10), 100));
42
+ const res = await fetch(`https://api.postcodes.io/postcodes?lon=${lon}&lat=${lat}&radius=${radius}&limit=${limit}`, { headers: { 'User-Agent': UA, Accept: 'application/json' }, signal: AbortSignal.timeout(20000) });
43
+ if (!res.ok)
44
+ throw new ZipError(`postcodes.io returned ${res.status}`);
45
+ const d = await res.json();
46
+ const rows = d.result ?? [];
47
+ if (!rows.length)
48
+ return `No postcodes reported near ${lat},${lon}.`;
49
+ return `Postcodes within ${radius}m of ${lat},${lon}:\n` + rows.slice(0, limit).map((r, i) => `${i + 1}. ${r.postcode ?? '?'} | ${r.distance != null ? `${Math.round(r.distance)}m` : 'distance not reported'} | ${r.admin_district ?? 'not reported'}, ${r.country ?? 'not reported'} | ${r.latitude ?? '?'},${r.longitude ?? '?'}`).join('\n');
50
+ }
51
+ export async function postcodeAutocomplete(args) {
52
+ const postcode = (args.postcode ?? '').trim();
53
+ if (!postcode)
54
+ throw new ZipError('Provide a postcode prefix.');
55
+ const limit = Math.max(1, Math.min(Math.round(args.limit ?? 10), 20));
56
+ const res = await fetch(`https://api.postcodes.io/postcodes/${encodeURIComponent(postcode)}/autocomplete?limit=${limit}`, { headers: { 'User-Agent': UA, Accept: 'application/json' }, signal: AbortSignal.timeout(20000) });
52
57
  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");
58
+ throw new ZipError(`postcodes.io returned ${res.status}`);
59
+ const d = await res.json();
60
+ const rows = d.result ?? [];
61
+ if (!rows.length)
62
+ return `No postcode completions for "${postcode}".`;
63
+ return `Postcode completions for "${postcode}":\n` + rows.slice(0, limit).join('\n');
73
64
  }
@@ -0,0 +1,85 @@
1
+ /**
2
+ * Thin client for the premium gateway.
3
+ *
4
+ * The premium tools do not run in this package any more. Their bodies live on
5
+ * the gateway, which checks a Polar licence key before it does any work, so
6
+ * deleting anything here buys nothing: the answer only exists behind the gate.
7
+ *
8
+ * Set `MCP_LICENSE_KEY` to a Polar licence key. `MCP_GATEWAY_URL` overrides the
9
+ * endpoint, which is only useful for testing.
10
+ */
11
+ const DEFAULT_GATEWAY_URL = 'https://mcp-gateway.contactae2000.workers.dev/mcp';
12
+ const DEFAULT_TIMEOUT_MS = 25000;
13
+ const USER_AGENT = 'mrfentmen-mcp/1.0';
14
+ /** Raised when a premium call cannot be completed. `message` is safe to show. */
15
+ export class GatewayError extends Error {
16
+ refused;
17
+ constructor(message, refused) {
18
+ super(message);
19
+ this.refused = refused;
20
+ this.name = 'GatewayError';
21
+ }
22
+ }
23
+ export async function premiumTool(tool, args) {
24
+ const key = (process.env.MCP_LICENSE_KEY ?? '').trim();
25
+ if (!key) {
26
+ throw new GatewayError(`"${tool}" is a premium tool and no licence key is set. Set MCP_LICENSE_KEY in your MCP client config.`, true);
27
+ }
28
+ const url = (process.env.MCP_GATEWAY_URL ?? DEFAULT_GATEWAY_URL).trim();
29
+ const controller = new AbortController();
30
+ const timer = setTimeout(() => controller.abort(), DEFAULT_TIMEOUT_MS);
31
+ let response;
32
+ try {
33
+ response = await fetch(url, {
34
+ method: 'POST',
35
+ headers: {
36
+ 'content-type': 'application/json',
37
+ accept: 'application/json',
38
+ 'user-agent': USER_AGENT,
39
+ authorization: `Bearer ${key}`,
40
+ },
41
+ body: JSON.stringify({
42
+ jsonrpc: '2.0',
43
+ id: 1,
44
+ method: 'tools/call',
45
+ params: { name: tool, arguments: args },
46
+ }),
47
+ signal: controller.signal,
48
+ });
49
+ }
50
+ catch {
51
+ throw new GatewayError(`"${tool}" could not reach the licence gateway. Check your connection and try again.`, false);
52
+ }
53
+ finally {
54
+ clearTimeout(timer);
55
+ }
56
+ if (!response.ok) {
57
+ throw new GatewayError(`"${tool}" could not reach the licence gateway (HTTP ${response.status}).`, false);
58
+ }
59
+ let body;
60
+ try {
61
+ body = (await response.json());
62
+ }
63
+ catch {
64
+ throw new GatewayError(`"${tool}" got an unreadable answer from the licence gateway.`, false);
65
+ }
66
+ if (body.error) {
67
+ throw new GatewayError(`"${tool}" was refused by the licence gateway: ${body.error.message ?? 'unknown error'}`, false);
68
+ }
69
+ const result = body.result ?? {};
70
+ const text = (result.content ?? [])
71
+ .map((part) => part.text ?? '')
72
+ .join('\n')
73
+ .trim();
74
+ if (result.isError) {
75
+ // The gateway marks a licence refusal structurally, so a missing or rejected
76
+ // key is told apart from a tool that failed after the gate let it through.
77
+ if (result.structuredContent?.licenceRefusal) {
78
+ throw new GatewayError(text || `"${tool}" needs a valid licence key.`, true);
79
+ }
80
+ throw new GatewayError(text || `"${tool}" failed on the licence gateway.`, false);
81
+ }
82
+ if (!text)
83
+ throw new GatewayError(`"${tool}" returned no data.`, false);
84
+ return text;
85
+ }
package/dist/server.js CHANGED
@@ -1,8 +1,7 @@
1
1
  import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
2
2
  import { z } from "zod";
3
- import { cityLookup } from "./api.js";
4
- import { zipLookup, reverseGeocode } from "./api.js";
5
- import { premiumRequired } from "./license.js";
3
+ import { cityLookup, zipLookup, nearbyPostcodes, postcodeAutocomplete } from "./api.js";
4
+ import { premiumTool } from "./gateway.js";
6
5
  const text = (value) => ({ content: [{ type: "text", text: value }] });
7
6
  const textError = (t) => ({ content: [{ type: "text", text: t }], isError: true });
8
7
  const READ_ONLY = { readOnlyHint: true, openWorldHint: true };
@@ -42,12 +41,52 @@ export function createServer() {
42
41
  annotations: READ_ONLY,
43
42
  }, async (args) => {
44
43
  // ---- paywall: reverse_geocode ----
45
- const paywallMessage = await premiumRequired("reverse_geocode");
46
- if (paywallMessage)
47
- return { content: [{ type: "text", text: paywallMessage }], isError: true };
44
+ // The body runs on the gateway, behind the licence gate.
48
45
  // ---- paywall: end ----
49
46
  try {
50
- return text(await reverseGeocode(args));
47
+ return text(await premiumTool("mcp_zip_codes_reverse_geocode", args));
48
+ }
49
+ catch (e) {
50
+ return textError(error(e));
51
+ }
52
+ });
53
+ server.registerTool("address_search", {
54
+ title: "Address search",
55
+ description: "Search worldwide addresses and places through OpenStreetMap Nominatim.",
56
+ inputSchema: z.object({ query: z.string().describe("Address or place query."), limit: z.number().optional().describe("Results, 1-10; default 5.") }),
57
+ annotations: READ_ONLY,
58
+ }, async (args) => {
59
+ // ---- paywall: address_search ----
60
+ // The body runs on the gateway, behind the licence gate.
61
+ // ---- paywall: end ----
62
+ try {
63
+ return text(await premiumTool("mcp_zip_codes_address_search", args));
64
+ }
65
+ catch (e) {
66
+ return textError(error(e));
67
+ }
68
+ });
69
+ server.registerTool("nearby_postcodes", {
70
+ title: "Nearby postcodes",
71
+ description: "Find UK postcodes near coordinates through postcodes.io.",
72
+ inputSchema: z.object({ latitude: z.number().describe("Latitude."), longitude: z.number().describe("Longitude."), radius: z.number().optional().describe("Radius in metres, 100-10000; default 5000."), limit: z.number().optional().describe("Results, 1-100; default 10.") }),
73
+ annotations: READ_ONLY,
74
+ }, async (args) => {
75
+ try {
76
+ return text(await nearbyPostcodes(args));
77
+ }
78
+ catch (e) {
79
+ return textError(error(e));
80
+ }
81
+ });
82
+ server.registerTool("postcode_autocomplete", {
83
+ title: "Postcode autocomplete",
84
+ description: "Complete a UK postcode prefix through postcodes.io.",
85
+ inputSchema: z.object({ postcode: z.string().describe("Postcode or prefix, e.g. SW1A."), limit: z.number().optional().describe("Completions, 1-20; default 10.") }),
86
+ annotations: READ_ONLY,
87
+ }, async (args) => {
88
+ try {
89
+ return text(await postcodeAutocomplete(args));
51
90
  }
52
91
  catch (e) {
53
92
  return textError(error(e));
package/package.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "1.0.1",
2
+ "version": "1.0.2",
3
3
  "type": "module",
4
4
  "repository": {
5
5
  "type": "git",
package/dist/license.js DELETED
@@ -1,78 +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 = "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
- }