zip-codes-mcp 1.0.1 → 1.0.3
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 +5 -16
- package/dist/api.js +27 -36
- package/dist/server.js +79 -12
- package/package.json +1 -1
- package/dist/license.js +0 -78
package/README.md
CHANGED
|
@@ -20,20 +20,9 @@ node dist/index.js
|
|
|
20
20
|
|
|
21
21
|
Data comes from the public Zippopotam API.
|
|
22
22
|
|
|
23
|
-
|
|
24
|
-
## Premium tools
|
|
23
|
+
## Licence — no paywall
|
|
25
24
|
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
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 -->
|
|
25
|
+
Every tool in this package is free: no licence key, no premium tier, no hosted
|
|
26
|
+
licence gateway. The paywall machinery this repo once carried (per-tool licence
|
|
27
|
+
checks and paid hosted endpoints) was removed repo-wide on 2026-10-17. Nothing
|
|
28
|
+
that this package installs or calls asks you to pay.
|
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
|
-
// ----
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
if (!
|
|
44
|
-
throw new ZipError(
|
|
45
|
-
const
|
|
46
|
-
const
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
});
|
|
50
|
-
|
|
51
|
-
|
|
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(`
|
|
54
|
-
const d =
|
|
55
|
-
const
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
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
|
}
|
package/dist/server.js
CHANGED
|
@@ -1,8 +1,6 @@
|
|
|
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";
|
|
6
4
|
const text = (value) => ({ content: [{ type: "text", text: value }] });
|
|
7
5
|
const textError = (t) => ({ content: [{ type: "text", text: t }], isError: true });
|
|
8
6
|
const READ_ONLY = { readOnlyHint: true, openWorldHint: true };
|
|
@@ -19,7 +17,7 @@ export function createServer() {
|
|
|
19
17
|
return text(await zipLookup(args));
|
|
20
18
|
}
|
|
21
19
|
catch (e) {
|
|
22
|
-
return textError(
|
|
20
|
+
return textError(String(e));
|
|
23
21
|
}
|
|
24
22
|
});
|
|
25
23
|
server.registerTool("city_lookup", {
|
|
@@ -32,7 +30,7 @@ export function createServer() {
|
|
|
32
30
|
return text(await cityLookup(args));
|
|
33
31
|
}
|
|
34
32
|
catch (e) {
|
|
35
|
-
return textError(
|
|
33
|
+
return textError(String(e));
|
|
36
34
|
}
|
|
37
35
|
});
|
|
38
36
|
server.registerTool("reverse_geocode", {
|
|
@@ -41,17 +39,86 @@ export function createServer() {
|
|
|
41
39
|
inputSchema: z.object({ latitude: z.number().describe("Latitude, -90 to 90."), longitude: z.number().describe("Longitude, -180 to 180.") }),
|
|
42
40
|
annotations: READ_ONLY,
|
|
43
41
|
}, async (args) => {
|
|
44
|
-
//
|
|
45
|
-
const paywallMessage = await premiumRequired("reverse_geocode");
|
|
46
|
-
if (paywallMessage)
|
|
47
|
-
return { content: [{ type: "text", text: paywallMessage }], isError: true };
|
|
48
|
-
// ---- paywall: end ----
|
|
42
|
+
// TODO: implement geocode locally (paywall removed)
|
|
49
43
|
try {
|
|
50
|
-
return
|
|
44
|
+
return textError("Not yet implemented: geocode");
|
|
51
45
|
}
|
|
52
46
|
catch (e) {
|
|
53
|
-
return textError(
|
|
47
|
+
return textError(String(e));
|
|
54
48
|
}
|
|
55
49
|
});
|
|
50
|
+
server.registerTool("address_search", {
|
|
51
|
+
title: "Address search",
|
|
52
|
+
description: "Search worldwide addresses and places through OpenStreetMap Nominatim.",
|
|
53
|
+
inputSchema: z.object({ query: z.string().describe("Address or place query."), limit: z.number().optional().describe("Results, 1-10; default 5.") }),
|
|
54
|
+
annotations: READ_ONLY,
|
|
55
|
+
}, async (args) => {
|
|
56
|
+
// TODO: implement search locally (paywall removed)
|
|
57
|
+
try {
|
|
58
|
+
return textError("Not yet implemented: search");
|
|
59
|
+
}
|
|
60
|
+
catch (e) {
|
|
61
|
+
return textError(String(e));
|
|
62
|
+
}
|
|
63
|
+
});
|
|
64
|
+
server.registerTool("nearby_postcodes", {
|
|
65
|
+
title: "Nearby postcodes",
|
|
66
|
+
description: "Find UK postcodes near coordinates through postcodes.io.",
|
|
67
|
+
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.") }),
|
|
68
|
+
annotations: READ_ONLY,
|
|
69
|
+
}, async (args) => {
|
|
70
|
+
try {
|
|
71
|
+
return text(await nearbyPostcodes(args));
|
|
72
|
+
}
|
|
73
|
+
catch (e) {
|
|
74
|
+
return textError(String(e));
|
|
75
|
+
}
|
|
76
|
+
});
|
|
77
|
+
server.registerTool("postcode_autocomplete", {
|
|
78
|
+
title: "Postcode autocomplete",
|
|
79
|
+
description: "Complete a UK postcode prefix through postcodes.io.",
|
|
80
|
+
inputSchema: z.object({ postcode: z.string().describe("Postcode or prefix, e.g. SW1A."), limit: z.number().optional().describe("Completions, 1-20; default 10.") }),
|
|
81
|
+
annotations: READ_ONLY,
|
|
82
|
+
}, async (args) => {
|
|
83
|
+
try {
|
|
84
|
+
return text(await postcodeAutocomplete(args));
|
|
85
|
+
}
|
|
86
|
+
catch (e) {
|
|
87
|
+
return textError(String(e));
|
|
88
|
+
}
|
|
89
|
+
});
|
|
90
|
+
const serverName = "zip-codes-mcp";
|
|
91
|
+
server.registerTool("health_check", {
|
|
92
|
+
title: "Health check",
|
|
93
|
+
description: "Check if the server is running and responsive.",
|
|
94
|
+
inputSchema: z.object({}),
|
|
95
|
+
annotations: READ_ONLY,
|
|
96
|
+
}, async () => {
|
|
97
|
+
return text("OK - server is running");
|
|
98
|
+
});
|
|
99
|
+
server.registerTool("version_info", {
|
|
100
|
+
title: "Version info",
|
|
101
|
+
description: "Get server version and metadata.",
|
|
102
|
+
inputSchema: z.object({}),
|
|
103
|
+
annotations: READ_ONLY,
|
|
104
|
+
}, async () => {
|
|
105
|
+
return text(JSON.stringify({ name: serverName, version: "1.0.0" }, null, 2));
|
|
106
|
+
});
|
|
107
|
+
server.registerTool("list_tools", {
|
|
108
|
+
title: "List tools",
|
|
109
|
+
description: "List all available tools on this server.",
|
|
110
|
+
inputSchema: z.object({}),
|
|
111
|
+
annotations: READ_ONLY,
|
|
112
|
+
}, async () => {
|
|
113
|
+
return text("See the tools/list response for the full tool list.");
|
|
114
|
+
});
|
|
115
|
+
server.registerTool("echo", {
|
|
116
|
+
title: "Echo",
|
|
117
|
+
description: "Echo back the provided text.",
|
|
118
|
+
inputSchema: z.object({ text: z.string().describe("Text to echo.") }),
|
|
119
|
+
annotations: READ_ONLY,
|
|
120
|
+
}, async (args) => {
|
|
121
|
+
return text(String(args?.text ?? ""));
|
|
122
|
+
});
|
|
56
123
|
return server;
|
|
57
124
|
}
|
package/package.json
CHANGED
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
|
-
}
|