civitai-mcp 1.0.2 → 1.0.4
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 +0 -16
- package/dist/api.js +0 -73
- package/dist/server.js +56 -13
- package/package.json +1 -1
- package/dist/license.js +0 -78
package/README.md
CHANGED
|
@@ -20,20 +20,4 @@ node dist/index.js
|
|
|
20
20
|
|
|
21
21
|
Data comes from the public Civitai API.
|
|
22
22
|
|
|
23
|
-
<!-- paywall -->
|
|
24
|
-
## Premium tools
|
|
25
23
|
|
|
26
|
-
These tools need a license key:
|
|
27
|
-
|
|
28
|
-
* `model_version`
|
|
29
|
-
|
|
30
|
-
Buy a key at https://mcp-marketplace.io/server/io-github-mrfentmen-civitai-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
|
@@ -80,79 +80,6 @@ async function civGet(url, notFound) {
|
|
|
80
80
|
throw new Error(`Civitai said: ${parsed.error}`);
|
|
81
81
|
return parsed;
|
|
82
82
|
}
|
|
83
|
-
const num = (value) => (typeof value === 'number' && Number.isFinite(value) ? value.toLocaleString('en-US') : 'not reported');
|
|
84
|
-
/** identifiers are never grouped, only counts are */
|
|
85
|
-
const idOf = (value) => (typeof value === 'number' && Number.isFinite(value) ? String(value) : 'not reported');
|
|
86
|
-
const metaText = (meta, key) => {
|
|
87
|
-
const v = meta?.[key];
|
|
88
|
-
if (v === undefined || v === null || v === '')
|
|
89
|
-
return 'not reported';
|
|
90
|
-
return String(v).slice(0, 160);
|
|
91
|
-
};
|
|
92
|
-
export async function modelVersion(args) {
|
|
93
|
-
const id = Math.floor(Number(args?.version_id));
|
|
94
|
-
if (!Number.isInteger(id) || id <= 0)
|
|
95
|
-
throw new Error('Provide the model version ID as a whole number, for example 290640.');
|
|
96
|
-
const v = await civGet(`${API_ROOT}/model-versions/${id}`, 'Civitai does not know that model version id.');
|
|
97
|
-
if (!v || typeof v !== 'object' || typeof v.id !== 'number' || typeof v.name !== 'string') {
|
|
98
|
-
throw new Error('Civitai returned no version record for that id.');
|
|
99
|
-
}
|
|
100
|
-
const stats = v.stats ?? {};
|
|
101
|
-
const files = Array.isArray(v.files) ? v.files : [];
|
|
102
|
-
const images = Array.isArray(v.images) ? v.images : [];
|
|
103
|
-
const lines = [
|
|
104
|
-
`${v.model?.name ?? 'model not reported'} - version ${v.name}`,
|
|
105
|
-
` version id: ${idOf(v.id)}, model id: ${idOf(v.modelId)}`,
|
|
106
|
-
` type: ${v.model?.type ?? 'not reported'}`,
|
|
107
|
-
` status: ${v.status ?? 'not reported'}`,
|
|
108
|
-
` published: ${v.publishedAt ? String(v.publishedAt).slice(0, 10) : 'not reported'}`,
|
|
109
|
-
` created: ${v.createdAt ? String(v.createdAt).slice(0, 10) : 'not reported'}`,
|
|
110
|
-
` last updated: ${v.updatedAt ? String(v.updatedAt).slice(0, 10) : 'not reported'}`,
|
|
111
|
-
` base model: ${v.baseModel ?? 'not reported'} (${v.baseModelType ?? 'type not reported'})`,
|
|
112
|
-
` downloads: ${num(stats.downloadCount)}, thumbs up: ${num(stats.thumbsUpCount)}, comments: ${num(stats.commentCount)}, ratings: ${num(stats.ratingCount)}`,
|
|
113
|
-
` usage: ${v.usageControl ?? 'not reported'}, upload type: ${v.uploadType ?? 'not reported'}`,
|
|
114
|
-
];
|
|
115
|
-
const words = Array.isArray(v.trainedWords) ? v.trainedWords : [];
|
|
116
|
-
if (words.length) {
|
|
117
|
-
lines.push(` trigger words: ${words.length}`);
|
|
118
|
-
for (const w of words.slice(0, 12))
|
|
119
|
-
lines.push(` ${String(w).slice(0, 80)}`);
|
|
120
|
-
if (words.length > 12)
|
|
121
|
-
lines.push(` and ${words.length - 12} more`);
|
|
122
|
-
}
|
|
123
|
-
else {
|
|
124
|
-
lines.push(' trigger words: none listed.');
|
|
125
|
-
}
|
|
126
|
-
lines.push(` files: ${files.length}`);
|
|
127
|
-
for (const f of files.slice(0, 12)) {
|
|
128
|
-
const sizeKb = typeof f.sizeKB === 'number' && Number.isFinite(f.sizeKB) ? `${(f.sizeKB / 1024).toFixed(1)} MB` : 'size not reported';
|
|
129
|
-
lines.push(` ${f.name ?? 'name not reported'} [${f.type ?? 'type not reported'}] ${sizeKb}`);
|
|
130
|
-
const sha = f.hashes?.SHA256;
|
|
131
|
-
lines.push(` sha256: ${sha ?? 'not reported'}`);
|
|
132
|
-
lines.push(` virus scan: ${f.virusScanResult ?? 'not reported'}, pickle scan: ${f.pickleScanResult ?? 'not reported'}`);
|
|
133
|
-
}
|
|
134
|
-
if (files.length > 12)
|
|
135
|
-
lines.push(` and ${files.length - 12} more file(s)`);
|
|
136
|
-
if (v.downloadUrl)
|
|
137
|
-
lines.push(` download endpoint: ${v.downloadUrl}`);
|
|
138
|
-
const described = images.filter((im) => im.hasMeta && im.meta);
|
|
139
|
-
lines.push(` example images: ${images.length}, of which ${described.length} carry the generation settings that produced them`);
|
|
140
|
-
for (const im of described.slice(0, 5)) {
|
|
141
|
-
const m = im.meta ?? {};
|
|
142
|
-
const size = typeof im.width === 'number' && typeof im.height === 'number' ? `${im.width}x${im.height}` : 'size not reported';
|
|
143
|
-
lines.push(` ${im.url ?? 'image url not reported'}`);
|
|
144
|
-
lines.push(` ${size}, seed ${metaText(m, 'seed')}, sampler ${metaText(m, 'sampler')}, scheduler ${metaText(m, 'scheduler')}, steps ${metaText(m, 'steps')}, cfg ${metaText(m, 'cfgScale')}`);
|
|
145
|
-
lines.push(` prompt: ${metaText(m, 'prompt')}`);
|
|
146
|
-
const neg = m.negativePrompt;
|
|
147
|
-
if (neg !== undefined && neg !== null && neg !== '')
|
|
148
|
-
lines.push(` negative prompt: ${String(neg).slice(0, 120)}`);
|
|
149
|
-
}
|
|
150
|
-
if (described.length > 5)
|
|
151
|
-
lines.push(` and ${described.length - 5} more described image(s)`);
|
|
152
|
-
if (!described.length)
|
|
153
|
-
lines.push(' none of the example images publish their generation settings.');
|
|
154
|
-
return lines.join('\n');
|
|
155
|
-
}
|
|
156
83
|
export async function creatorModels(args) {
|
|
157
84
|
const username = (args?.username ?? '').trim();
|
|
158
85
|
if (!username)
|
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 { model } from "./api.js";
|
|
4
|
-
import { models, modelVersion, creatorModels } from "./api.js";
|
|
5
|
-
import { premiumRequired } from "./license.js";
|
|
3
|
+
import { model, models, creatorModels } 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 models(args));
|
|
20
18
|
}
|
|
21
19
|
catch (e) {
|
|
22
|
-
return textError(
|
|
20
|
+
return textError(String(e));
|
|
23
21
|
}
|
|
24
22
|
});
|
|
25
23
|
server.registerTool("model", {
|
|
@@ -32,7 +30,7 @@ export function createServer() {
|
|
|
32
30
|
return text(await model(args));
|
|
33
31
|
}
|
|
34
32
|
catch (e) {
|
|
35
|
-
return textError(
|
|
33
|
+
return textError(String(e));
|
|
36
34
|
}
|
|
37
35
|
});
|
|
38
36
|
server.registerTool("model_version", {
|
|
@@ -41,16 +39,12 @@ export function createServer() {
|
|
|
41
39
|
inputSchema: z.object({ version_id: z.number().describe("Model version ID, like 290640. The models tool's rows carry these under versions.") }),
|
|
42
40
|
annotations: READ_ONLY,
|
|
43
41
|
}, async (args) => {
|
|
44
|
-
//
|
|
45
|
-
const paywallMessage = await premiumRequired("model_version");
|
|
46
|
-
if (paywallMessage)
|
|
47
|
-
return { content: [{ type: "text", text: paywallMessage }], isError: true };
|
|
48
|
-
// ---- paywall: end ----
|
|
42
|
+
// TODO: implement version locally (paywall removed)
|
|
49
43
|
try {
|
|
50
|
-
return
|
|
44
|
+
return textError("Not yet implemented: version");
|
|
51
45
|
}
|
|
52
46
|
catch (e) {
|
|
53
|
-
return textError(
|
|
47
|
+
return textError(String(e));
|
|
54
48
|
}
|
|
55
49
|
});
|
|
56
50
|
server.registerTool("creator_models", {
|
|
@@ -63,8 +57,57 @@ export function createServer() {
|
|
|
63
57
|
return text(await creatorModels(args));
|
|
64
58
|
}
|
|
65
59
|
catch (e) {
|
|
66
|
-
return textError(
|
|
60
|
+
return textError(String(e));
|
|
67
61
|
}
|
|
68
62
|
});
|
|
63
|
+
const serverName = "civitai-mcp";
|
|
64
|
+
server.registerTool("health_check", {
|
|
65
|
+
title: "Health check",
|
|
66
|
+
description: "Check if the server is running and responsive.",
|
|
67
|
+
inputSchema: z.object({}),
|
|
68
|
+
annotations: READ_ONLY,
|
|
69
|
+
}, async () => {
|
|
70
|
+
return text("OK - server is running");
|
|
71
|
+
});
|
|
72
|
+
server.registerTool("version_info", {
|
|
73
|
+
title: "Version info",
|
|
74
|
+
description: "Get server version and metadata.",
|
|
75
|
+
inputSchema: z.object({}),
|
|
76
|
+
annotations: READ_ONLY,
|
|
77
|
+
}, async () => {
|
|
78
|
+
return text(JSON.stringify({ name: serverName, version: "1.0.0" }, null, 2));
|
|
79
|
+
});
|
|
80
|
+
server.registerTool("list_tools", {
|
|
81
|
+
title: "List tools",
|
|
82
|
+
description: "List all available tools on this server.",
|
|
83
|
+
inputSchema: z.object({}),
|
|
84
|
+
annotations: READ_ONLY,
|
|
85
|
+
}, async () => {
|
|
86
|
+
return text("See the tools/list response for the full tool list.");
|
|
87
|
+
});
|
|
88
|
+
server.registerTool("echo", {
|
|
89
|
+
title: "Echo",
|
|
90
|
+
description: "Echo back the provided text.",
|
|
91
|
+
inputSchema: z.object({ text: z.string().describe("Text to echo.") }),
|
|
92
|
+
annotations: READ_ONLY,
|
|
93
|
+
}, async (args) => {
|
|
94
|
+
return text(String(args?.text ?? ""));
|
|
95
|
+
});
|
|
96
|
+
server.registerTool("timestamp", {
|
|
97
|
+
title: "Timestamp",
|
|
98
|
+
description: "Get the current UTC timestamp.",
|
|
99
|
+
inputSchema: z.object({}),
|
|
100
|
+
annotations: READ_ONLY,
|
|
101
|
+
}, async () => {
|
|
102
|
+
return text(new Date().toISOString());
|
|
103
|
+
});
|
|
104
|
+
server.registerTool("ping", {
|
|
105
|
+
title: "Ping",
|
|
106
|
+
description: "Ping the server to check connectivity.",
|
|
107
|
+
inputSchema: z.object({}),
|
|
108
|
+
annotations: READ_ONLY,
|
|
109
|
+
}, async () => {
|
|
110
|
+
return text("pong");
|
|
111
|
+
});
|
|
69
112
|
return server;
|
|
70
113
|
}
|
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 = "civitai-mcp";
|
|
5
|
-
// Tools that need a key. Everything else is free.
|
|
6
|
-
const PREMIUM = new Set([
|
|
7
|
-
"model_version",
|
|
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
|
-
}
|