zip-codes-mcp 1.0.0 → 1.0.2

package/README.md

@@ -19,3 +19,22 @@ node dist/index.js
 ```
 
 Data comes from the public Zippopotam API.
+
+<!-- paywall -->
+## Premium tools
+
+These tools need a licence key:
+
+* `reverse_geocode`
+* `address_search`
+
+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:
+
+```json
+"env": { "MCP_LICENSE_KEY": "polar_..." }
+```
+
+The gateway checks the key against Polar and gives every key 1,000 free premium
+calls a month before per-call billing starts. Every other tool on this server
+stays free.
+<!-- /paywall -->

package/dist/api.js

@@ -33,3 +33,32 @@ export async function cityLookup(args) {
     const zips = [...new Set(places.map((p) => p?.["post code"]).filter(Boolean))];
     return `${city[0].toUpperCase()}${city.slice(1)}, ${state.toUpperCase()}\nZip codes: ${zips.join(", ")}`;
 }
+// ---- gap4c4 tools:
+export async function nearbyPostcodes(args) {
+    const lat = Number(args.latitude), lon = Number(args.longitude);
+    if (!Number.isFinite(lat) || lat < -90 || lat > 90 || !Number.isFinite(lon) || lon < -180 || lon > 180)
+        throw new ZipError('Provide valid latitude and longitude.');
+    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));
+    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) });
+    if (!res.ok)
+        throw new ZipError(`postcodes.io returned ${res.status}`);
+    const d = await res.json();
+    const rows = d.result ?? [];
+    if (!rows.length)
+        return `No postcodes reported near ${lat},${lon}.`;
+    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');
+}
+export async function postcodeAutocomplete(args) {
+    const postcode = (args.postcode ?? '').trim();
+    if (!postcode)
+        throw new ZipError('Provide a postcode prefix.');
+    const limit = Math.max(1, Math.min(Math.round(args.limit ?? 10), 20));
+    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) });
+    if (!res.ok)
+        throw new ZipError(`postcodes.io returned ${res.status}`);
+    const d = await res.json();
+    const rows = d.result ?? [];
+    if (!rows.length)
+        return `No postcode completions for "${postcode}".`;
+    return `Postcode completions for "${postcode}":\n` + rows.slice(0, limit).join('\n');
+}

package/dist/gateway.js

@@ -0,0 +1,85 @@
+/**
+ * Thin client for the premium gateway.
+ *
+ * The premium tools do not run in this package any more. Their bodies live on
+ * the gateway, which checks a Polar licence key before it does any work, so
+ * deleting anything here buys nothing: the answer only exists behind the gate.
+ *
+ * Set `MCP_LICENSE_KEY` to a Polar licence key. `MCP_GATEWAY_URL` overrides the
+ * endpoint, which is only useful for testing.
+ */
+const DEFAULT_GATEWAY_URL = 'https://mcp-gateway.contactae2000.workers.dev/mcp';
+const DEFAULT_TIMEOUT_MS = 25000;
+const USER_AGENT = 'mrfentmen-mcp/1.0';
+/** Raised when a premium call cannot be completed. `message` is safe to show. */
+export class GatewayError extends Error {
+    refused;
+    constructor(message, refused) {
+        super(message);
+        this.refused = refused;
+        this.name = 'GatewayError';
+    }
+}
+export async function premiumTool(tool, args) {
+    const key = (process.env.MCP_LICENSE_KEY ?? '').trim();
+    if (!key) {
+        throw new GatewayError(`"${tool}" is a premium tool and no licence key is set. Set MCP_LICENSE_KEY in your MCP client config.`, true);
+    }
+    const url = (process.env.MCP_GATEWAY_URL ?? DEFAULT_GATEWAY_URL).trim();
+    const controller = new AbortController();
+    const timer = setTimeout(() => controller.abort(), DEFAULT_TIMEOUT_MS);
+    let response;
+    try {
+        response = await fetch(url, {
+            method: 'POST',
+            headers: {
+                'content-type': 'application/json',
+                accept: 'application/json',
+                'user-agent': USER_AGENT,
+                authorization: `Bearer ${key}`,
+            },
+            body: JSON.stringify({
+                jsonrpc: '2.0',
+                id: 1,
+                method: 'tools/call',
+                params: { name: tool, arguments: args },
+            }),
+            signal: controller.signal,
+        });
+    }
+    catch {
+        throw new GatewayError(`"${tool}" could not reach the licence gateway. Check your connection and try again.`, false);
+    }
+    finally {
+        clearTimeout(timer);
+    }
+    if (!response.ok) {
+        throw new GatewayError(`"${tool}" could not reach the licence gateway (HTTP ${response.status}).`, false);
+    }
+    let body;
+    try {
+        body = (await response.json());
+    }
+    catch {
+        throw new GatewayError(`"${tool}" got an unreadable answer from the licence gateway.`, false);
+    }
+    if (body.error) {
+        throw new GatewayError(`"${tool}" was refused by the licence gateway: ${body.error.message ?? 'unknown error'}`, false);
+    }
+    const result = body.result ?? {};
+    const text = (result.content ?? [])
+        .map((part) => part.text ?? '')
+        .join('\n')
+        .trim();
+    if (result.isError) {
+        // The gateway marks a licence refusal structurally, so a missing or rejected
+        // key is told apart from a tool that failed after the gate let it through.
+        if (result.structuredContent?.licenceRefusal) {
+            throw new GatewayError(text || `"${tool}" needs a valid licence key.`, true);
+        }
+        throw new GatewayError(text || `"${tool}" failed on the licence gateway.`, false);
+    }
+    if (!text)
+        throw new GatewayError(`"${tool}" returned no data.`, false);
+    return text;
+}

package/dist/server.js

@@ -1,7 +1,7 @@
 import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { z } from "zod";
-import { cityLookup } from "./api.js";
-import { zipLookup } from "./api.js";
+import { cityLookup, zipLookup, nearbyPostcodes, postcodeAutocomplete } from "./api.js";
+import { premiumTool } from "./gateway.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 };
@@ -34,5 +34,63 @@ export function createServer() {
             return textError(error(e));
         }
     });
+    server.registerTool("reverse_geocode", {
+        title: "Reverse geocode",
+        description: "Turn a latitude and longitude into the post code, city, state and country that OpenStreetMap Nominatim has for that point.",
+        inputSchema: z.object({ latitude: z.number().describe("Latitude, -90 to 90."), longitude: z.number().describe("Longitude, -180 to 180.") }),
+        annotations: READ_ONLY,
+    }, async (args) => {
+        // ---- paywall: reverse_geocode ----
+        // The body runs on the gateway, behind the licence gate.
+        // ---- paywall: end ----
+        try {
+            return text(await premiumTool("mcp_zip_codes_reverse_geocode", args));
+        }
+        catch (e) {
+            return textError(error(e));
+        }
+    });
+    server.registerTool("address_search", {
+        title: "Address search",
+        description: "Search worldwide addresses and places through OpenStreetMap Nominatim.",
+        inputSchema: z.object({ query: z.string().describe("Address or place query."), limit: z.number().optional().describe("Results, 1-10; default 5.") }),
+        annotations: READ_ONLY,
+    }, async (args) => {
+        // ---- paywall: address_search ----
+        // The body runs on the gateway, behind the licence gate.
+        // ---- paywall: end ----
+        try {
+            return text(await premiumTool("mcp_zip_codes_address_search", args));
+        }
+        catch (e) {
+            return textError(error(e));
+        }
+    });
+    server.registerTool("nearby_postcodes", {
+        title: "Nearby postcodes",
+        description: "Find UK postcodes near coordinates through postcodes.io.",
+        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.") }),
+        annotations: READ_ONLY,
+    }, async (args) => {
+        try {
+            return text(await nearbyPostcodes(args));
+        }
+        catch (e) {
+            return textError(error(e));
+        }
+    });
+    server.registerTool("postcode_autocomplete", {
+        title: "Postcode autocomplete",
+        description: "Complete a UK postcode prefix through postcodes.io.",
+        inputSchema: z.object({ postcode: z.string().describe("Postcode or prefix, e.g. SW1A."), limit: z.number().optional().describe("Completions, 1-20; default 10.") }),
+        annotations: READ_ONLY,
+    }, async (args) => {
+        try {
+            return text(await postcodeAutocomplete(args));
+        }
+        catch (e) {
+            return textError(error(e));
+        }
+    });
     return server;
 }

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.0.0",
+  "version": "1.0.2",
   "type": "module",
   "repository": {
     "type": "git",