wikimedia-commons-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 +19 -0
- package/dist/api.js +64 -0
- package/dist/license.js +79 -0
- package/dist/server.js +51 -1
- package/package.json +1 -1
- package/src/api.ts +70 -0
- package/src/license.ts +89 -0
- package/src/server.ts +49 -1
package/README.md
CHANGED
|
@@ -21,3 +21,22 @@ node dist/index.js
|
|
|
21
21
|
## Source
|
|
22
22
|
|
|
23
23
|
Public free APIs only. See `src/api.ts` for exact endpoints.
|
|
24
|
+
|
|
25
|
+
<!-- paywall -->
|
|
26
|
+
## Premium tools
|
|
27
|
+
|
|
28
|
+
These tools need a license key:
|
|
29
|
+
|
|
30
|
+
* `file_categories`
|
|
31
|
+
* `file_thumbnail`
|
|
32
|
+
|
|
33
|
+
Buy a key at https://mcp-marketplace.io/server/io-github-mrfentmen-wikimedia-commons-mcp and set it in your MCP client config:
|
|
34
|
+
|
|
35
|
+
```json
|
|
36
|
+
"env": { "MCP_LICENSE_KEY": "mcp_live_..." }
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
The key is checked against MCP Marketplace, cached for 24 hours, and keeps
|
|
40
|
+
working offline once one check has succeeded. Every other tool on this server
|
|
41
|
+
stays free.
|
|
42
|
+
<!-- /paywall -->
|
package/dist/api.js
CHANGED
|
@@ -102,3 +102,67 @@ export const m0_file = m0.file;
|
|
|
102
102
|
export const m0_search = m0.search;
|
|
103
103
|
export const m0_CommonsError = m0.CommonsError;
|
|
104
104
|
export const m1_random = m1.random;
|
|
105
|
+
// ---- muxC tools:
|
|
106
|
+
const COMMONS_BASE = "https://commons.wikimedia.org/w/api.php";
|
|
107
|
+
const COMMONS_UA = "mrfentmen-wikimedia-commons-mcp/1.0 (https://github.com/mrfentmen)";
|
|
108
|
+
class CommonsLookupError extends Error {
|
|
109
|
+
}
|
|
110
|
+
async function commonsGet(url) {
|
|
111
|
+
const res = await fetch(url, {
|
|
112
|
+
headers: { "User-Agent": COMMONS_UA, Accept: "application/json" },
|
|
113
|
+
signal: AbortSignal.timeout(30000),
|
|
114
|
+
});
|
|
115
|
+
if (!res.ok)
|
|
116
|
+
throw new CommonsLookupError(`Wikimedia Commons returned HTTP ${res.status}`);
|
|
117
|
+
return res.json();
|
|
118
|
+
}
|
|
119
|
+
function commonsTitle(args) {
|
|
120
|
+
const title = (args.title ?? "").trim();
|
|
121
|
+
if (!title)
|
|
122
|
+
throw new CommonsLookupError("Provide a file title like File:Example.jpg");
|
|
123
|
+
return title.startsWith("File:") ? title : `File:${title}`;
|
|
124
|
+
}
|
|
125
|
+
/** The categories a file sits in, which is how Commons files are browsed. */
|
|
126
|
+
export async function fileCategories(args) {
|
|
127
|
+
const title = commonsTitle(args);
|
|
128
|
+
const limit = Math.max(1, Math.min(args.limit ?? 15, 50));
|
|
129
|
+
const d = await commonsGet(`${COMMONS_BASE}?action=query&titles=${encodeURIComponent(title)}&prop=categories&cllimit=${limit}&format=json&origin=*`);
|
|
130
|
+
const pages = Object.values(d?.query?.pages ?? {});
|
|
131
|
+
const page = pages[0];
|
|
132
|
+
if (!page || page.missing !== undefined)
|
|
133
|
+
throw new CommonsLookupError(`File not found: ${title}`);
|
|
134
|
+
const cats = page.categories ?? [];
|
|
135
|
+
if (!cats.length)
|
|
136
|
+
return `${page.title} is in no categories.`;
|
|
137
|
+
return `Categories for ${page.title} (${cats.length}${cats.length >= limit ? "+, capped by limit" : ""}):\n` +
|
|
138
|
+
cats.map((c, i) => `${i + 1}. ${c.title}${c.hidden === true ? " (hidden)" : ""}`).join("\n");
|
|
139
|
+
}
|
|
140
|
+
/** A thumbnail URL at a chosen width, so a client can fetch a sized copy. */
|
|
141
|
+
export async function fileThumbnail(args) {
|
|
142
|
+
const title = commonsTitle(args);
|
|
143
|
+
const width = Math.max(20, Math.min(args.width ?? 320, 2000));
|
|
144
|
+
const d = await commonsGet(`${COMMONS_BASE}?action=query&titles=${encodeURIComponent(title)}&prop=imageinfo&iiprop=url|size|mime&iiurlwidth=${width}&format=json&origin=*`);
|
|
145
|
+
const pages = Object.values(d?.query?.pages ?? {});
|
|
146
|
+
const info = pages[0]?.imageinfo?.[0];
|
|
147
|
+
if (!info)
|
|
148
|
+
throw new CommonsLookupError(`No image info for ${title}`);
|
|
149
|
+
return [
|
|
150
|
+
`File: ${pages[0]?.title ?? title}`,
|
|
151
|
+
`Original: ${info.url ?? "not reported"} (${info.width ?? "?"}x${info.height ?? "?"}, ${info.mime ?? "?"})`,
|
|
152
|
+
`Thumbnail at ${width}px: ${info.thumburl ?? "not offered by Commons for this file"}`,
|
|
153
|
+
].join("\n");
|
|
154
|
+
}
|
|
155
|
+
/** Browse a Commons category and list the media files inside it. */
|
|
156
|
+
export async function categoryFiles(args) {
|
|
157
|
+
const raw = (args.category ?? "").trim();
|
|
158
|
+
if (!raw)
|
|
159
|
+
throw new CommonsLookupError("Provide a category name, e.g. Featured pictures of animals");
|
|
160
|
+
const category = raw.startsWith("Category:") ? raw : `Category:${raw}`;
|
|
161
|
+
const limit = Math.max(1, Math.min(args.limit ?? 10, 50));
|
|
162
|
+
const d = await commonsGet(`${COMMONS_BASE}?action=query&list=categorymembers&cmtitle=${encodeURIComponent(category)}&cmtype=file|subcat&cmlimit=${limit}&format=json&origin=*`);
|
|
163
|
+
const rows = d?.query?.categorymembers ?? [];
|
|
164
|
+
if (!rows.length)
|
|
165
|
+
return `Commons category ${category} has no file or subcategory members.`;
|
|
166
|
+
return `Members of ${category} (${rows.length} shown):\n` +
|
|
167
|
+
rows.map((m, i) => `${i + 1}. ${m.title} (${m.ns === 14 ? "subcategory" : "file"})`).join("\n");
|
|
168
|
+
}
|
package/dist/license.js
ADDED
|
@@ -0,0 +1,79 @@
|
|
|
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 = "wikimedia-commons-mcp";
|
|
5
|
+
// Tools that need a key. Everything else is free.
|
|
6
|
+
const PREMIUM = new Set([
|
|
7
|
+
"file_categories",
|
|
8
|
+
"file_thumbnail",
|
|
9
|
+
]);
|
|
10
|
+
const BUY_URL = `https://mcp-marketplace.io/server/io-github-mrfentmen-${SLUG}`;
|
|
11
|
+
// The license check calls the marketplace's verify endpoint directly instead of
|
|
12
|
+
// using @mcp_marketplace/license. That SDK sends no `apikey` header, so every
|
|
13
|
+
// check it makes is rejected by Supabase before it reaches the function. The
|
|
14
|
+
// publishable key below is public by design - it ships in mcp-marketplace.io's
|
|
15
|
+
// own JavaScript and only ever reaches their licence check.
|
|
16
|
+
const DEFAULT_VERIFY_URL = "https://virupvwhtkpkjsiskckg.supabase.co/functions/v1/verify-key";
|
|
17
|
+
const PUBLISHABLE_KEY = "sb_publishable_BuqlW96Ke8C_zzJG-LQv1Q_YHi_r_4h";
|
|
18
|
+
const OK_CACHE_MS = 60 * 60 * 1000;
|
|
19
|
+
const BAD_CACHE_MS = 60 * 1000;
|
|
20
|
+
const seen = new Map();
|
|
21
|
+
const REASONS = {
|
|
22
|
+
missing_key: "no key is set",
|
|
23
|
+
invalid_format: "that key is not a valid MCP Marketplace key",
|
|
24
|
+
not_found: "that key was not found",
|
|
25
|
+
revoked: "that key has been revoked",
|
|
26
|
+
rotated: "that key was rotated, use your new one",
|
|
27
|
+
expired: "that key has expired, renew it",
|
|
28
|
+
rate_limited: "there were too many checks just now, try again shortly",
|
|
29
|
+
network_error: "the license server could not be reached",
|
|
30
|
+
};
|
|
31
|
+
function blocked(tool, reason) {
|
|
32
|
+
const why = REASONS[reason] ?? `the license server answered "${reason}"`;
|
|
33
|
+
return `"${tool}" needs a license key, but ${why}. ` +
|
|
34
|
+
`Set MCP_LICENSE_KEY in your MCP client config. Get a key: ${BUY_URL}`;
|
|
35
|
+
}
|
|
36
|
+
async function verify(key) {
|
|
37
|
+
const res = await fetch(process.env.MCP_LICENSE_VERIFY_URL || DEFAULT_VERIFY_URL, {
|
|
38
|
+
method: "POST",
|
|
39
|
+
headers: {
|
|
40
|
+
apikey: PUBLISHABLE_KEY,
|
|
41
|
+
Authorization: `Bearer ${PUBLISHABLE_KEY}`,
|
|
42
|
+
"Content-Type": "application/json",
|
|
43
|
+
},
|
|
44
|
+
body: JSON.stringify({ key, slug: SLUG }),
|
|
45
|
+
// an unusable key answers 400 with a JSON body, so read the body either way
|
|
46
|
+
signal: AbortSignal.timeout(15000),
|
|
47
|
+
});
|
|
48
|
+
const data = (await res.json());
|
|
49
|
+
if (typeof data?.valid !== "boolean")
|
|
50
|
+
return { valid: false, reason: "unexpected_response" };
|
|
51
|
+
return data;
|
|
52
|
+
}
|
|
53
|
+
/**
|
|
54
|
+
* Returns null when the caller may run the tool, or a short message telling
|
|
55
|
+
* them how to get a key.
|
|
56
|
+
*
|
|
57
|
+
* A good key is remembered for an hour, so a busy session does not hit the
|
|
58
|
+
* license server on every call and keeps working through a brief outage.
|
|
59
|
+
*/
|
|
60
|
+
export async function premiumRequired(tool) {
|
|
61
|
+
if (!PREMIUM.has(tool))
|
|
62
|
+
return null;
|
|
63
|
+
const key = process.env.MCP_LICENSE_KEY;
|
|
64
|
+
if (!key)
|
|
65
|
+
return blocked(tool, "missing_key");
|
|
66
|
+
const hit = seen.get(key);
|
|
67
|
+
if (hit && Date.now() - hit.at < (hit.valid ? OK_CACHE_MS : BAD_CACHE_MS)) {
|
|
68
|
+
return hit.valid ? null : blocked(tool, hit.reason ?? "invalid");
|
|
69
|
+
}
|
|
70
|
+
let result;
|
|
71
|
+
try {
|
|
72
|
+
result = await verify(key);
|
|
73
|
+
}
|
|
74
|
+
catch {
|
|
75
|
+
result = { valid: false, reason: "network_error" };
|
|
76
|
+
}
|
|
77
|
+
seen.set(key, { ...result, at: Date.now() });
|
|
78
|
+
return result.valid ? null : blocked(tool, result.reason ?? "invalid");
|
|
79
|
+
}
|
package/dist/server.js
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
|
|
2
2
|
import { z } from 'zod';
|
|
3
|
-
import { m0_file, m0_search, m1_random } from './api.js';
|
|
3
|
+
import { m0_file, m0_search, m1_random, fileCategories, fileThumbnail, categoryFiles } from './api.js';
|
|
4
|
+
import { premiumRequired } from "./license.js";
|
|
4
5
|
const text = (value) => ({ content: [{ type: 'text', text: value }] });
|
|
5
6
|
const textError = (t) => ({ content: [{ type: "text", text: t }], isError: true });
|
|
6
7
|
const READ_ONLY = { readOnlyHint: true, openWorldHint: true };
|
|
@@ -47,5 +48,54 @@ export function createServer() {
|
|
|
47
48
|
return textError(error(e));
|
|
48
49
|
}
|
|
49
50
|
});
|
|
51
|
+
server.registerTool("file_categories", {
|
|
52
|
+
title: "File categories",
|
|
53
|
+
description: "The Wikimedia Commons categories a file sits in, which is how Commons media gets browsed.",
|
|
54
|
+
inputSchema: z.object({ title: z.string().describe("File title like File:Example.jpg."), limit: z.number().describe("Max categories.").optional() }),
|
|
55
|
+
annotations: READ_ONLY,
|
|
56
|
+
}, async (args) => {
|
|
57
|
+
// ---- paywall: file_categories ----
|
|
58
|
+
const paywallMessage = await premiumRequired("file_categories");
|
|
59
|
+
if (paywallMessage)
|
|
60
|
+
return { content: [{ type: "text", text: paywallMessage }], isError: true };
|
|
61
|
+
// ---- paywall: end ----
|
|
62
|
+
try {
|
|
63
|
+
return text(await fileCategories(args));
|
|
64
|
+
}
|
|
65
|
+
catch (e) {
|
|
66
|
+
return textError(error(e));
|
|
67
|
+
}
|
|
68
|
+
});
|
|
69
|
+
server.registerTool("file_thumbnail", {
|
|
70
|
+
title: "File thumbnail",
|
|
71
|
+
description: "The thumbnail URL for a Commons file at a chosen pixel width, alongside the original's dimensions and MIME type.",
|
|
72
|
+
inputSchema: z.object({ title: z.string().describe("File title like File:Example.jpg."), width: z.number().describe("Thumbnail width in pixels, 20 to 2000.").optional() }),
|
|
73
|
+
annotations: READ_ONLY,
|
|
74
|
+
}, async (args) => {
|
|
75
|
+
// ---- paywall: file_thumbnail ----
|
|
76
|
+
const paywallMessage = await premiumRequired("file_thumbnail");
|
|
77
|
+
if (paywallMessage)
|
|
78
|
+
return { content: [{ type: "text", text: paywallMessage }], isError: true };
|
|
79
|
+
// ---- paywall: end ----
|
|
80
|
+
try {
|
|
81
|
+
return text(await fileThumbnail(args));
|
|
82
|
+
}
|
|
83
|
+
catch (e) {
|
|
84
|
+
return textError(error(e));
|
|
85
|
+
}
|
|
86
|
+
});
|
|
87
|
+
server.registerTool("category_files", {
|
|
88
|
+
title: "Category files",
|
|
89
|
+
description: "List the media files and subcategories inside a Wikimedia Commons category.",
|
|
90
|
+
inputSchema: z.object({ category: z.string().describe("Category name, e.g. Featured pictures of animals."), limit: z.number().describe("Max members.").optional() }),
|
|
91
|
+
annotations: READ_ONLY,
|
|
92
|
+
}, async (args) => {
|
|
93
|
+
try {
|
|
94
|
+
return text(await categoryFiles(args));
|
|
95
|
+
}
|
|
96
|
+
catch (e) {
|
|
97
|
+
return textError(error(e));
|
|
98
|
+
}
|
|
99
|
+
});
|
|
50
100
|
return server;
|
|
51
101
|
}
|
package/package.json
CHANGED
package/src/api.ts
CHANGED
|
@@ -111,3 +111,73 @@ export const m0_file = m0.file;
|
|
|
111
111
|
export const m0_search = m0.search;
|
|
112
112
|
export const m0_CommonsError = m0.CommonsError;
|
|
113
113
|
export const m1_random = m1.random;
|
|
114
|
+
|
|
115
|
+
// ---- muxC tools:
|
|
116
|
+
|
|
117
|
+
const COMMONS_BASE = "https://commons.wikimedia.org/w/api.php"
|
|
118
|
+
const COMMONS_UA = "mrfentmen-wikimedia-commons-mcp/1.0 (https://github.com/mrfentmen)"
|
|
119
|
+
|
|
120
|
+
class CommonsLookupError extends Error {}
|
|
121
|
+
|
|
122
|
+
async function commonsGet(url: string): Promise<any> {
|
|
123
|
+
const res = await fetch(url, {
|
|
124
|
+
headers: { "User-Agent": COMMONS_UA, Accept: "application/json" },
|
|
125
|
+
signal: AbortSignal.timeout(30000),
|
|
126
|
+
})
|
|
127
|
+
if (!res.ok) throw new CommonsLookupError(`Wikimedia Commons returned HTTP ${res.status}`)
|
|
128
|
+
return res.json()
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
function commonsTitle(args: { title?: string }): string {
|
|
132
|
+
const title = (args.title ?? "").trim()
|
|
133
|
+
if (!title) throw new CommonsLookupError("Provide a file title like File:Example.jpg")
|
|
134
|
+
return title.startsWith("File:") ? title : `File:${title}`
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
/** The categories a file sits in, which is how Commons files are browsed. */
|
|
138
|
+
export async function fileCategories(args: { title?: string; limit?: number }): Promise<string> {
|
|
139
|
+
const title = commonsTitle(args)
|
|
140
|
+
const limit = Math.max(1, Math.min(args.limit ?? 15, 50))
|
|
141
|
+
const d = await commonsGet(
|
|
142
|
+
`${COMMONS_BASE}?action=query&titles=${encodeURIComponent(title)}&prop=categories&cllimit=${limit}&format=json&origin=*`,
|
|
143
|
+
)
|
|
144
|
+
const pages = Object.values(d?.query?.pages ?? {}) as any[]
|
|
145
|
+
const page = pages[0]
|
|
146
|
+
if (!page || page.missing !== undefined) throw new CommonsLookupError(`File not found: ${title}`)
|
|
147
|
+
const cats = page.categories ?? []
|
|
148
|
+
if (!cats.length) return `${page.title} is in no categories.`
|
|
149
|
+
return `Categories for ${page.title} (${cats.length}${cats.length >= limit ? "+, capped by limit" : ""}):\n` +
|
|
150
|
+
cats.map((c: any, i: number) => `${i + 1}. ${c.title}${c.hidden === true ? " (hidden)" : ""}`).join("\n")
|
|
151
|
+
}
|
|
152
|
+
|
|
153
|
+
/** A thumbnail URL at a chosen width, so a client can fetch a sized copy. */
|
|
154
|
+
export async function fileThumbnail(args: { title?: string; width?: number }): Promise<string> {
|
|
155
|
+
const title = commonsTitle(args)
|
|
156
|
+
const width = Math.max(20, Math.min(args.width ?? 320, 2000))
|
|
157
|
+
const d = await commonsGet(
|
|
158
|
+
`${COMMONS_BASE}?action=query&titles=${encodeURIComponent(title)}&prop=imageinfo&iiprop=url|size|mime&iiurlwidth=${width}&format=json&origin=*`,
|
|
159
|
+
)
|
|
160
|
+
const pages = Object.values(d?.query?.pages ?? {}) as any[]
|
|
161
|
+
const info = pages[0]?.imageinfo?.[0]
|
|
162
|
+
if (!info) throw new CommonsLookupError(`No image info for ${title}`)
|
|
163
|
+
return [
|
|
164
|
+
`File: ${pages[0]?.title ?? title}`,
|
|
165
|
+
`Original: ${info.url ?? "not reported"} (${info.width ?? "?"}x${info.height ?? "?"}, ${info.mime ?? "?"})`,
|
|
166
|
+
`Thumbnail at ${width}px: ${info.thumburl ?? "not offered by Commons for this file"}`,
|
|
167
|
+
].join("\n")
|
|
168
|
+
}
|
|
169
|
+
|
|
170
|
+
/** Browse a Commons category and list the media files inside it. */
|
|
171
|
+
export async function categoryFiles(args: { category?: string; limit?: number }): Promise<string> {
|
|
172
|
+
const raw = (args.category ?? "").trim()
|
|
173
|
+
if (!raw) throw new CommonsLookupError("Provide a category name, e.g. Featured pictures of animals")
|
|
174
|
+
const category = raw.startsWith("Category:") ? raw : `Category:${raw}`
|
|
175
|
+
const limit = Math.max(1, Math.min(args.limit ?? 10, 50))
|
|
176
|
+
const d = await commonsGet(
|
|
177
|
+
`${COMMONS_BASE}?action=query&list=categorymembers&cmtitle=${encodeURIComponent(category)}&cmtype=file|subcat&cmlimit=${limit}&format=json&origin=*`,
|
|
178
|
+
)
|
|
179
|
+
const rows = d?.query?.categorymembers ?? []
|
|
180
|
+
if (!rows.length) return `Commons category ${category} has no file or subcategory members.`
|
|
181
|
+
return `Members of ${category} (${rows.length} shown):\n` +
|
|
182
|
+
rows.map((m: any, i: number) => `${i + 1}. ${m.title} (${m.ns === 14 ? "subcategory" : "file"})`).join("\n")
|
|
183
|
+
}
|
package/src/license.ts
ADDED
|
@@ -0,0 +1,89 @@
|
|
|
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 = "wikimedia-commons-mcp"
|
|
5
|
+
|
|
6
|
+
// Tools that need a key. Everything else is free.
|
|
7
|
+
const PREMIUM = new Set<string>([
|
|
8
|
+
"file_categories",
|
|
9
|
+
"file_thumbnail",
|
|
10
|
+
])
|
|
11
|
+
|
|
12
|
+
const BUY_URL = `https://mcp-marketplace.io/server/io-github-mrfentmen-${SLUG}`
|
|
13
|
+
|
|
14
|
+
// The license check calls the marketplace's verify endpoint directly instead of
|
|
15
|
+
// using @mcp_marketplace/license. That SDK sends no `apikey` header, so every
|
|
16
|
+
// check it makes is rejected by Supabase before it reaches the function. The
|
|
17
|
+
// publishable key below is public by design - it ships in mcp-marketplace.io's
|
|
18
|
+
// own JavaScript and only ever reaches their licence check.
|
|
19
|
+
const DEFAULT_VERIFY_URL = "https://virupvwhtkpkjsiskckg.supabase.co/functions/v1/verify-key"
|
|
20
|
+
const PUBLISHABLE_KEY = "sb_publishable_BuqlW96Ke8C_zzJG-LQv1Q_YHi_r_4h"
|
|
21
|
+
|
|
22
|
+
const OK_CACHE_MS = 60 * 60 * 1000
|
|
23
|
+
const BAD_CACHE_MS = 60 * 1000
|
|
24
|
+
|
|
25
|
+
type Check = { valid: boolean; reason?: string }
|
|
26
|
+
|
|
27
|
+
const seen = new Map<string, Check & { at: number }>()
|
|
28
|
+
|
|
29
|
+
const REASONS: Record<string, string> = {
|
|
30
|
+
missing_key: "no key is set",
|
|
31
|
+
invalid_format: "that key is not a valid MCP Marketplace key",
|
|
32
|
+
not_found: "that key was not found",
|
|
33
|
+
revoked: "that key has been revoked",
|
|
34
|
+
rotated: "that key was rotated, use your new one",
|
|
35
|
+
expired: "that key has expired, renew it",
|
|
36
|
+
rate_limited: "there were too many checks just now, try again shortly",
|
|
37
|
+
network_error: "the license server could not be reached",
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
function blocked(tool: string, reason: string): string {
|
|
41
|
+
const why = REASONS[reason] ?? `the license server answered "${reason}"`
|
|
42
|
+
return `"${tool}" needs a license key, but ${why}. ` +
|
|
43
|
+
`Set MCP_LICENSE_KEY in your MCP client config. Get a key: ${BUY_URL}`
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
async function verify(key: string): Promise<Check> {
|
|
47
|
+
const res = await fetch(process.env.MCP_LICENSE_VERIFY_URL || DEFAULT_VERIFY_URL, {
|
|
48
|
+
method: "POST",
|
|
49
|
+
headers: {
|
|
50
|
+
apikey: PUBLISHABLE_KEY,
|
|
51
|
+
Authorization: `Bearer ${PUBLISHABLE_KEY}`,
|
|
52
|
+
"Content-Type": "application/json",
|
|
53
|
+
},
|
|
54
|
+
body: JSON.stringify({ key, slug: SLUG }),
|
|
55
|
+
// an unusable key answers 400 with a JSON body, so read the body either way
|
|
56
|
+
signal: AbortSignal.timeout(15000),
|
|
57
|
+
})
|
|
58
|
+
const data = (await res.json()) as Check
|
|
59
|
+
if (typeof data?.valid !== "boolean") return { valid: false, reason: "unexpected_response" }
|
|
60
|
+
return data
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
/**
|
|
64
|
+
* Returns null when the caller may run the tool, or a short message telling
|
|
65
|
+
* them how to get a key.
|
|
66
|
+
*
|
|
67
|
+
* A good key is remembered for an hour, so a busy session does not hit the
|
|
68
|
+
* license server on every call and keeps working through a brief outage.
|
|
69
|
+
*/
|
|
70
|
+
export async function premiumRequired(tool: string): Promise<string | null> {
|
|
71
|
+
if (!PREMIUM.has(tool)) return null
|
|
72
|
+
|
|
73
|
+
const key = process.env.MCP_LICENSE_KEY
|
|
74
|
+
if (!key) return blocked(tool, "missing_key")
|
|
75
|
+
|
|
76
|
+
const hit = seen.get(key)
|
|
77
|
+
if (hit && Date.now() - hit.at < (hit.valid ? OK_CACHE_MS : BAD_CACHE_MS)) {
|
|
78
|
+
return hit.valid ? null : blocked(tool, hit.reason ?? "invalid")
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
let result: Check
|
|
82
|
+
try {
|
|
83
|
+
result = await verify(key)
|
|
84
|
+
} catch {
|
|
85
|
+
result = { valid: false, reason: "network_error" }
|
|
86
|
+
}
|
|
87
|
+
seen.set(key, { ...result, at: Date.now() })
|
|
88
|
+
return result.valid ? null : blocked(tool, result.reason ?? "invalid")
|
|
89
|
+
}
|
package/src/server.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js'
|
|
2
2
|
import { z } from 'zod'
|
|
3
|
-
import { m0_file, m0_search, m1_random } from './api.js'
|
|
3
|
+
import { m0_file, m0_search, m1_random, fileCategories, fileThumbnail, categoryFiles } from './api.js'
|
|
4
|
+
import { premiumRequired } from "./license.js"
|
|
4
5
|
|
|
5
6
|
const text = (value: string) => ({ content: [{ type: 'text' as const, text: value }] })
|
|
6
7
|
const textError = (t: string) => ({ content: [{ type: "text" as const, text: t }], isError: true as const })
|
|
@@ -46,5 +47,52 @@ server.registerTool(
|
|
|
46
47
|
try { return text(await m1_random(args)) } catch (e) { return textError(error(e)) }
|
|
47
48
|
}
|
|
48
49
|
)
|
|
50
|
+
server.registerTool(
|
|
51
|
+
"file_categories",
|
|
52
|
+
{
|
|
53
|
+
title: "File categories",
|
|
54
|
+
description: "The Wikimedia Commons categories a file sits in, which is how Commons media gets browsed.",
|
|
55
|
+
inputSchema: z.object( { title: z.string().describe("File title like File:Example.jpg."), limit: z.number().describe("Max categories.").optional() }),
|
|
56
|
+
annotations: READ_ONLY,
|
|
57
|
+
},
|
|
58
|
+
async (args) => {
|
|
59
|
+
// ---- paywall: file_categories ----
|
|
60
|
+
const paywallMessage = await premiumRequired("file_categories")
|
|
61
|
+
if (paywallMessage) return { content: [{ type: "text" as const, text: paywallMessage }], isError: true }
|
|
62
|
+
// ---- paywall: end ----
|
|
63
|
+
try { return text(await fileCategories(args)) } catch (e) { return textError(error(e)) }
|
|
64
|
+
}
|
|
65
|
+
)
|
|
66
|
+
|
|
67
|
+
server.registerTool(
|
|
68
|
+
"file_thumbnail",
|
|
69
|
+
{
|
|
70
|
+
title: "File thumbnail",
|
|
71
|
+
description: "The thumbnail URL for a Commons file at a chosen pixel width, alongside the original's dimensions and MIME type.",
|
|
72
|
+
inputSchema: z.object( { title: z.string().describe("File title like File:Example.jpg."), width: z.number().describe("Thumbnail width in pixels, 20 to 2000.").optional() }),
|
|
73
|
+
annotations: READ_ONLY,
|
|
74
|
+
},
|
|
75
|
+
async (args) => {
|
|
76
|
+
// ---- paywall: file_thumbnail ----
|
|
77
|
+
const paywallMessage = await premiumRequired("file_thumbnail")
|
|
78
|
+
if (paywallMessage) return { content: [{ type: "text" as const, text: paywallMessage }], isError: true }
|
|
79
|
+
// ---- paywall: end ----
|
|
80
|
+
try { return text(await fileThumbnail(args)) } catch (e) { return textError(error(e)) }
|
|
81
|
+
}
|
|
82
|
+
)
|
|
83
|
+
|
|
84
|
+
server.registerTool(
|
|
85
|
+
"category_files",
|
|
86
|
+
{
|
|
87
|
+
title: "Category files",
|
|
88
|
+
description: "List the media files and subcategories inside a Wikimedia Commons category.",
|
|
89
|
+
inputSchema: z.object( { category: z.string().describe("Category name, e.g. Featured pictures of animals."), limit: z.number().describe("Max members.").optional() }),
|
|
90
|
+
annotations: READ_ONLY,
|
|
91
|
+
},
|
|
92
|
+
async (args) => {
|
|
93
|
+
try { return text(await categoryFiles(args)) } catch (e) { return textError(error(e)) }
|
|
94
|
+
}
|
|
95
|
+
)
|
|
96
|
+
|
|
49
97
|
return server
|
|
50
98
|
}
|