countryflags-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 +18 -0
- package/dist/api.js +62 -0
- package/dist/license.js +78 -0
- package/dist/server.js +33 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -19,3 +19,21 @@ node dist/index.js
|
|
|
19
19
|
```
|
|
20
20
|
|
|
21
21
|
Data comes from the public Flagcdn API.
|
|
22
|
+
|
|
23
|
+
<!-- paywall -->
|
|
24
|
+
## Premium tools
|
|
25
|
+
|
|
26
|
+
These tools need a license key:
|
|
27
|
+
|
|
28
|
+
* `flag_urls`
|
|
29
|
+
|
|
30
|
+
Buy a key at https://mcp-marketplace.io/server/io-github-mrfentmen-countryflags-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
|
@@ -23,3 +23,65 @@ export async function flag(args) {
|
|
|
23
23
|
return 'Provide a country code like us.';
|
|
24
24
|
return `${code.toUpperCase()}: ${BASE}/${code}.png (w160: ${BASE}/w160/${code}.png, w320: ${BASE}/w320/${code}.png)`;
|
|
25
25
|
}
|
|
26
|
+
// ---- muxA tools:
|
|
27
|
+
// The existing tools search the code list and print a bare flag url. The bare
|
|
28
|
+
// form has no size and answers 404, so these return only the sized urls that
|
|
29
|
+
// really exist and resolve a country or region name to its code.
|
|
30
|
+
/** Sizes confirmed to answer 200 for a country code. Anything else 404s. */
|
|
31
|
+
const SIZES = [
|
|
32
|
+
'w20', 'w40', 'w80', 'w160', 'w320', 'w640', 'w1280', 'w2560',
|
|
33
|
+
'h20', 'h24', 'h40', 'h60', 'h80', 'h120',
|
|
34
|
+
'24x18', '32x24', '48x36', '64x48', '96x72', '128x96', '256x192',
|
|
35
|
+
];
|
|
36
|
+
async function codes() {
|
|
37
|
+
const res = await fetch(`${BASE}/en/codes.json`, {
|
|
38
|
+
headers: { 'User-Agent': 'mrfentmen-countryflags-mcp/1.0', Accept: 'application/json' },
|
|
39
|
+
signal: AbortSignal.timeout(20000),
|
|
40
|
+
});
|
|
41
|
+
if (!res.ok)
|
|
42
|
+
throw new Error(`Flagcdn returned ${res.status}`);
|
|
43
|
+
const d = (await res.json());
|
|
44
|
+
return d && typeof d === 'object' ? d : {};
|
|
45
|
+
}
|
|
46
|
+
function sizeList(requested) {
|
|
47
|
+
if (!requested)
|
|
48
|
+
return SIZES;
|
|
49
|
+
const wanted = requested.split(/[,\s]+/).filter(Boolean).map((s) => s.toLowerCase());
|
|
50
|
+
const bad = wanted.filter((s) => !SIZES.includes(s));
|
|
51
|
+
if (bad.length)
|
|
52
|
+
throw new Error(`These sizes do not exist: ${bad.join(', ')}. Available: ${SIZES.join(', ')}.`);
|
|
53
|
+
return wanted;
|
|
54
|
+
}
|
|
55
|
+
export async function flagUrls(args) {
|
|
56
|
+
const code = (args.code ?? '').trim().toLowerCase();
|
|
57
|
+
if (!code)
|
|
58
|
+
throw new Error('Provide a country code like us, or a subdivision code like gb-eng.');
|
|
59
|
+
const names = await codes();
|
|
60
|
+
if (!names[code]) {
|
|
61
|
+
throw new Error(`Flagcdn has no code "${code}". It serves ${Object.keys(names).length} codes, including ${Object.keys(names).slice(0, 8).join(', ')}.`);
|
|
62
|
+
}
|
|
63
|
+
const wanted = sizeList(args.sizes);
|
|
64
|
+
const lines = [`${names[code]} (${code.toUpperCase()}):`];
|
|
65
|
+
for (const size of wanted)
|
|
66
|
+
lines.push(` ${size}: ${BASE}/${size}/${code}.png`);
|
|
67
|
+
lines.push(`The bare ${BASE}/${code}.png answers 404, so a size is always required.`);
|
|
68
|
+
return lines.join('\n');
|
|
69
|
+
}
|
|
70
|
+
export async function resolveName(args) {
|
|
71
|
+
const query = (args.name ?? '').trim().toLowerCase();
|
|
72
|
+
if (!query)
|
|
73
|
+
throw new Error('Provide a country or region name, or part of one.');
|
|
74
|
+
const names = await codes();
|
|
75
|
+
const hits = Object.entries(names).filter(([code, name]) => name.toLowerCase().includes(query) || code === query);
|
|
76
|
+
if (!hits.length)
|
|
77
|
+
return `No flag matches "${args.name}".`;
|
|
78
|
+
const wanted = sizeList(args.sizes);
|
|
79
|
+
const shown = hits.slice(0, 10);
|
|
80
|
+
const lines = [`Flags matching "${args.name}": ${hits.length}${hits.length > shown.length ? `, showing ${shown.length}` : ''}`];
|
|
81
|
+
for (const [code, name] of shown) {
|
|
82
|
+
lines.push(` ${name} (${code})`);
|
|
83
|
+
for (const size of wanted.slice(0, 3))
|
|
84
|
+
lines.push(` ${BASE}/${size}/${code}.png`);
|
|
85
|
+
}
|
|
86
|
+
return lines.join('\n');
|
|
87
|
+
}
|
package/dist/license.js
ADDED
|
@@ -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 = "countryflags-mcp";
|
|
5
|
+
// Tools that need a key. Everything else is free.
|
|
6
|
+
const PREMIUM = new Set([
|
|
7
|
+
"flag_urls",
|
|
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 { flag } from "./api.js";
|
|
4
|
-
import { list } from "./api.js";
|
|
4
|
+
import { list, flagUrls, resolveName } 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,36 @@ export function createServer() {
|
|
|
34
35
|
return textError(error(e));
|
|
35
36
|
}
|
|
36
37
|
});
|
|
38
|
+
server.registerTool("flag_urls", {
|
|
39
|
+
title: "Flag urls",
|
|
40
|
+
description: "Every working size url for one flag code, checked against the live code list and restricted to the sizes that really exist. The unsized url the flag tool prints answers 404.",
|
|
41
|
+
inputSchema: z.object({ code: z.string().describe("Country code like us, or a subdivision code like gb-eng."), sizes: z.string().describe("Comma separated sizes to show, like w320,256x192. Defaults to all 21 that exist.").optional() }),
|
|
42
|
+
annotations: READ_ONLY,
|
|
43
|
+
}, async (args) => {
|
|
44
|
+
// ---- paywall: flag_urls ----
|
|
45
|
+
const paywallMessage = await premiumRequired("flag_urls");
|
|
46
|
+
if (paywallMessage)
|
|
47
|
+
return { content: [{ type: "text", text: paywallMessage }], isError: true };
|
|
48
|
+
// ---- paywall: end ----
|
|
49
|
+
try {
|
|
50
|
+
return text(await flagUrls(args));
|
|
51
|
+
}
|
|
52
|
+
catch (e) {
|
|
53
|
+
return textError(error(e));
|
|
54
|
+
}
|
|
55
|
+
});
|
|
56
|
+
server.registerTool("resolve_name", {
|
|
57
|
+
title: "Resolve name",
|
|
58
|
+
description: "Find flag codes by country or region name and get real image urls for each, instead of guessing the two letter code.",
|
|
59
|
+
inputSchema: z.object({ name: z.string().describe("Country or region name or part of one, like united or korea."), sizes: z.string().describe("Comma separated sizes to show, like w320. Defaults to all 21 that exist.").optional() }),
|
|
60
|
+
annotations: READ_ONLY,
|
|
61
|
+
}, async (args) => {
|
|
62
|
+
try {
|
|
63
|
+
return text(await resolveName(args));
|
|
64
|
+
}
|
|
65
|
+
catch (e) {
|
|
66
|
+
return textError(error(e));
|
|
67
|
+
}
|
|
68
|
+
});
|
|
37
69
|
return server;
|
|
38
70
|
}
|
package/package.json
CHANGED