finalspace-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 +155 -0
- package/dist/license.js +79 -0
- package/dist/server.js +51 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -19,3 +19,22 @@ node dist/index.js
|
|
|
19
19
|
```
|
|
20
20
|
|
|
21
21
|
Data comes from the public Final Space API.
|
|
22
|
+
|
|
23
|
+
<!-- paywall -->
|
|
24
|
+
## Premium tools
|
|
25
|
+
|
|
26
|
+
These tools need a license key:
|
|
27
|
+
|
|
28
|
+
* `roster_census`
|
|
29
|
+
* `alias_index`
|
|
30
|
+
|
|
31
|
+
Buy a key at https://mcp-marketplace.io/server/io-github-mrfentmen-finalspace-mcp and set it in your MCP client config:
|
|
32
|
+
|
|
33
|
+
```json
|
|
34
|
+
"env": { "MCP_LICENSE_KEY": "mcp_live_..." }
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
The key is checked against MCP Marketplace, cached for 24 hours, and keeps
|
|
38
|
+
working offline once one check has succeeded. Every other tool on this server
|
|
39
|
+
stays free.
|
|
40
|
+
<!-- /paywall -->
|
package/dist/api.js
CHANGED
|
@@ -35,3 +35,158 @@ export async function character(args) {
|
|
|
35
35
|
abilities.length ? `Abilities: ${abilities.slice(0, 5).join(', ')}` : '',
|
|
36
36
|
].filter(Boolean).join('\n');
|
|
37
37
|
}
|
|
38
|
+
// ---- muxF tools:
|
|
39
|
+
const SPACE_API = 'https://finalspaceapi.com/api/v0';
|
|
40
|
+
async function roster() {
|
|
41
|
+
const res = await fetch(`${SPACE_API}/character/`, {
|
|
42
|
+
headers: { 'User-Agent': 'mrfentmen-finalspace-mcp/1.0', Accept: 'application/json' },
|
|
43
|
+
signal: AbortSignal.timeout(20000),
|
|
44
|
+
});
|
|
45
|
+
if (!res.ok)
|
|
46
|
+
throw new Error(`Final Space returned ${res.status}`);
|
|
47
|
+
const d = (await res.json());
|
|
48
|
+
if (!Array.isArray(d) || !d.length)
|
|
49
|
+
throw new Error('Final Space returned no characters.');
|
|
50
|
+
return d;
|
|
51
|
+
}
|
|
52
|
+
function bound(value, min, max, fallback) {
|
|
53
|
+
const n = Number(value);
|
|
54
|
+
if (!Number.isFinite(n))
|
|
55
|
+
return fallback;
|
|
56
|
+
return Math.max(min, Math.min(Math.floor(n), max));
|
|
57
|
+
}
|
|
58
|
+
function field(c, key) {
|
|
59
|
+
const value = c[key];
|
|
60
|
+
return typeof value === 'string' && value.trim() ? value.trim() : 'not reported';
|
|
61
|
+
}
|
|
62
|
+
function tally(map, cap) {
|
|
63
|
+
if (!map.size)
|
|
64
|
+
return 'not reported';
|
|
65
|
+
return [...map.entries()]
|
|
66
|
+
.sort((a, b) => b[1] - a[1] || String(a[0]).localeCompare(String(b[0])))
|
|
67
|
+
.slice(0, cap)
|
|
68
|
+
.map(([k, n]) => `${k} ${n}`)
|
|
69
|
+
.join(', ');
|
|
70
|
+
}
|
|
71
|
+
/** A census of the whole cast: who is alive, what they are, where they are from and what they can do. */
|
|
72
|
+
export async function rosterCensus(args) {
|
|
73
|
+
const rows = await roster();
|
|
74
|
+
const limit = bound(args.limit, 1, 20, 8);
|
|
75
|
+
const statuses = new Map();
|
|
76
|
+
const species = new Map();
|
|
77
|
+
const genders = new Map();
|
|
78
|
+
const origins = new Map();
|
|
79
|
+
const hair = new Map();
|
|
80
|
+
const abilities = new Map();
|
|
81
|
+
let withAbilities = 0;
|
|
82
|
+
let withAliases = 0;
|
|
83
|
+
let aliasTotal = 0;
|
|
84
|
+
for (const c of rows) {
|
|
85
|
+
statuses.set(field(c, 'status'), (statuses.get(field(c, 'status')) ?? 0) + 1);
|
|
86
|
+
species.set(field(c, 'species'), (species.get(field(c, 'species')) ?? 0) + 1);
|
|
87
|
+
genders.set(field(c, 'gender'), (genders.get(field(c, 'gender')) ?? 0) + 1);
|
|
88
|
+
origins.set(field(c, 'origin'), (origins.get(field(c, 'origin')) ?? 0) + 1);
|
|
89
|
+
hair.set(field(c, 'hair'), (hair.get(field(c, 'hair')) ?? 0) + 1);
|
|
90
|
+
const list = c.abilities ?? [];
|
|
91
|
+
if (list.length)
|
|
92
|
+
withAbilities += 1;
|
|
93
|
+
for (const a of list)
|
|
94
|
+
abilities.set(a, (abilities.get(a) ?? 0) + 1);
|
|
95
|
+
const alias = c.alias ?? [];
|
|
96
|
+
if (alias.length)
|
|
97
|
+
withAliases += 1;
|
|
98
|
+
aliasTotal += alias.length;
|
|
99
|
+
}
|
|
100
|
+
const alive = (statuses.get('Alive') ?? 0);
|
|
101
|
+
return [
|
|
102
|
+
`Final Space cast census over ${rows.length} character(s)`,
|
|
103
|
+
`Status: ${tally(statuses, limit)}`,
|
|
104
|
+
`Alive: ${alive} of ${rows.length} (${((alive / rows.length) * 100).toFixed(1)}%), with ${rows.length - alive} not recorded as alive`,
|
|
105
|
+
`Species: ${rows.length} distinct values, leading them ${tally(species, limit)}`,
|
|
106
|
+
`Gender: ${rows.length} distinct values as the API records them, leading them ${tally(genders, limit)}`,
|
|
107
|
+
`Origin: ${origins.size} distinct origins, leading them ${tally(origins, limit)}`,
|
|
108
|
+
`Hair: ${tally(hair, limit)}`,
|
|
109
|
+
`Characters with at least one ability: ${withAbilities} of ${rows.length}`,
|
|
110
|
+
`Distinct abilities across the cast: ${abilities.size}, from ${[...abilities.values()].reduce((a, b) => a + b, 0)} mentions, most common ${tally(abilities, 8)}`,
|
|
111
|
+
`Aliases: ${aliasTotal} across ${withAliases} character(s), so ${(aliasTotal / Math.max(1, withAliases)).toFixed(1)} per character that has any`,
|
|
112
|
+
].join('\n');
|
|
113
|
+
}
|
|
114
|
+
/** Resolve a code name or alias back to the character who carries it, which the name and id tools cannot do. */
|
|
115
|
+
export async function aliasIndex(args) {
|
|
116
|
+
const rows = await roster();
|
|
117
|
+
const query = (args.query ?? '').trim().toLowerCase();
|
|
118
|
+
const limit = bound(args.limit, 1, 40, 20);
|
|
119
|
+
const entries = [];
|
|
120
|
+
for (const c of rows) {
|
|
121
|
+
for (const alias of c.alias ?? [])
|
|
122
|
+
entries.push({ alias, name: field(c, 'name'), id: Number(c.id ?? 0) });
|
|
123
|
+
}
|
|
124
|
+
const hits = query ? entries.filter((e) => e.alias.toLowerCase().includes(query) || e.name.toLowerCase().includes(query)) : entries;
|
|
125
|
+
const most = new Map();
|
|
126
|
+
for (const c of rows)
|
|
127
|
+
most.set(field(c, 'name'), (c.alias ?? []).length);
|
|
128
|
+
const busiest = [...most.entries()].sort((a, b) => b[1] - a[1]).slice(0, 5);
|
|
129
|
+
if (!hits.length) {
|
|
130
|
+
return `No alias or character name in the ${entries.length} recorded aliases contains "${query}".`;
|
|
131
|
+
}
|
|
132
|
+
return [
|
|
133
|
+
query ? `Alias matches for "${query}" across the ${entries.length} aliases the API records:` : `Every alias the API records: ${entries.length}`,
|
|
134
|
+
`Aliases are matched loosely, so a code name in the show can often be resolved to a character id here.`,
|
|
135
|
+
...hits.slice(0, limit).map((e, i) => `${i + 1}. "${e.alias}" -> ${e.name} (character id ${e.id || 'not reported'})`),
|
|
136
|
+
hits.length > limit ? `... and ${hits.length - limit} more match(es).` : '',
|
|
137
|
+
`Characters with the most aliases: ${busiest.map(([k, n]) => `${k} (${n})`).join(', ')}`,
|
|
138
|
+
].filter(Boolean).join('\n');
|
|
139
|
+
}
|
|
140
|
+
/** The origin view of the cast: who comes from where and which abilities each origin brings with it. */
|
|
141
|
+
export async function originMap(args) {
|
|
142
|
+
const rows = await roster();
|
|
143
|
+
const limit = bound(args.limit, 1, 20, 10);
|
|
144
|
+
const wanted = (args.origin ?? '').trim().toLowerCase();
|
|
145
|
+
const origins = new Map();
|
|
146
|
+
for (const c of rows) {
|
|
147
|
+
const key = field(c, 'origin');
|
|
148
|
+
const list = origins.get(key) ?? [];
|
|
149
|
+
list.push(c);
|
|
150
|
+
origins.set(key, list);
|
|
151
|
+
}
|
|
152
|
+
if (wanted) {
|
|
153
|
+
const matches = [...origins.entries()].filter(([k]) => k.toLowerCase().includes(wanted));
|
|
154
|
+
if (!matches.length) {
|
|
155
|
+
const known = [...origins.keys()].sort().slice(0, 20);
|
|
156
|
+
return `No character origin contains "${args.origin ?? wanted}". Origins the API records: ${known.join(', ')}.`;
|
|
157
|
+
}
|
|
158
|
+
for (const [origin, members] of matches) {
|
|
159
|
+
const shared = new Map();
|
|
160
|
+
for (const c of members)
|
|
161
|
+
for (const a of c.abilities ?? [])
|
|
162
|
+
shared.set(a, (shared.get(a) ?? 0) + 1);
|
|
163
|
+
const lines = [
|
|
164
|
+
`Origin ${origin}: ${members.length} character(s)`,
|
|
165
|
+
...members.slice(0, limit).map((c) => {
|
|
166
|
+
const abilities = (c.abilities ?? []).slice(0, 4);
|
|
167
|
+
return `- ${field(c, 'name')} (id ${c.id ?? '?'}), ${field(c, 'species')}, ${field(c, 'status')}${abilities.length ? ` | abilities: ${abilities.join(', ')}` : ' | no abilities recorded'}`;
|
|
168
|
+
}),
|
|
169
|
+
members.length > limit ? `... and ${members.length - limit} more from this origin.` : '',
|
|
170
|
+
`Abilities appearing in this origin: ${tally(shared, 10)}`,
|
|
171
|
+
];
|
|
172
|
+
return lines.filter(Boolean).join('\n');
|
|
173
|
+
}
|
|
174
|
+
}
|
|
175
|
+
const unknown = (origins.get('Unknown') ?? []).length;
|
|
176
|
+
const lines = [
|
|
177
|
+
`Origins across the ${rows.length} characters the API records: ${origins.size}`,
|
|
178
|
+
`Characters with an origin the API does not name: ${unknown}`,
|
|
179
|
+
...[...origins.entries()]
|
|
180
|
+
.sort((a, b) => b[1].length - a[1].length)
|
|
181
|
+
.slice(0, limit)
|
|
182
|
+
.map(([origin, members]) => {
|
|
183
|
+
const abilities = new Set();
|
|
184
|
+
for (const c of members)
|
|
185
|
+
for (const a of c.abilities ?? [])
|
|
186
|
+
abilities.add(a);
|
|
187
|
+
const alive = members.filter((c) => field(c, 'status') === 'Alive').length;
|
|
188
|
+
return `- ${origin}: ${members.length} character(s), ${alive} alive, ${abilities.size} distinct abilit${abilities.size === 1 ? 'y' : 'ies'}`;
|
|
189
|
+
}),
|
|
190
|
+
];
|
|
191
|
+
return lines.join('\n');
|
|
192
|
+
}
|
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 = "finalspace-mcp";
|
|
5
|
+
// Tools that need a key. Everything else is free.
|
|
6
|
+
const PREMIUM = new Set([
|
|
7
|
+
"roster_census",
|
|
8
|
+
"alias_index",
|
|
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,7 +1,8 @@
|
|
|
1
1
|
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
|
2
2
|
import { z } from "zod";
|
|
3
3
|
import { character } from "./api.js";
|
|
4
|
-
import { characters } from "./api.js";
|
|
4
|
+
import { characters, rosterCensus, aliasIndex, originMap } 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,54 @@ export function createServer() {
|
|
|
34
35
|
return textError(error(e));
|
|
35
36
|
}
|
|
36
37
|
});
|
|
38
|
+
server.registerTool("roster_census", {
|
|
39
|
+
title: "Roster census",
|
|
40
|
+
description: "A census of the whole Final Space cast: the status spread and how much of it is alive, the species, gender, origin and hair distributions, how many characters carry abilities, how many distinct abilities there are and which are most common, and the alias count per character.",
|
|
41
|
+
inputSchema: z.object({ limit: z.number().describe("Values to list per distribution, 1-20.").optional() }),
|
|
42
|
+
annotations: READ_ONLY,
|
|
43
|
+
}, async (args) => {
|
|
44
|
+
// ---- paywall: roster_census ----
|
|
45
|
+
const paywallMessage = await premiumRequired("roster_census");
|
|
46
|
+
if (paywallMessage)
|
|
47
|
+
return { content: [{ type: "text", text: paywallMessage }], isError: true };
|
|
48
|
+
// ---- paywall: end ----
|
|
49
|
+
try {
|
|
50
|
+
return text(await rosterCensus(args));
|
|
51
|
+
}
|
|
52
|
+
catch (e) {
|
|
53
|
+
return textError(error(e));
|
|
54
|
+
}
|
|
55
|
+
});
|
|
56
|
+
server.registerTool("alias_index", {
|
|
57
|
+
title: "Alias index",
|
|
58
|
+
description: "Resolve a code name or alias back to the character who carries it, by matching across every alias the API records and reporting the character id. With no query it lists the whole alias index and the characters with the most aliases.",
|
|
59
|
+
inputSchema: z.object({ query: z.string().describe("Alias or character name to look for.").optional(), limit: z.number().describe("Matches to list, 1-40.").optional() }),
|
|
60
|
+
annotations: READ_ONLY,
|
|
61
|
+
}, async (args) => {
|
|
62
|
+
// ---- paywall: alias_index ----
|
|
63
|
+
const paywallMessage = await premiumRequired("alias_index");
|
|
64
|
+
if (paywallMessage)
|
|
65
|
+
return { content: [{ type: "text", text: paywallMessage }], isError: true };
|
|
66
|
+
// ---- paywall: end ----
|
|
67
|
+
try {
|
|
68
|
+
return text(await aliasIndex(args));
|
|
69
|
+
}
|
|
70
|
+
catch (e) {
|
|
71
|
+
return textError(error(e));
|
|
72
|
+
}
|
|
73
|
+
});
|
|
74
|
+
server.registerTool("origin_map", {
|
|
75
|
+
title: "Origin map",
|
|
76
|
+
description: "The origin view of the cast: how many characters come from each origin, how many of those are alive, and which abilities appear in that origin. Name one origin to see its members and their abilities.",
|
|
77
|
+
inputSchema: z.object({ origin: z.string().describe("Origin name to focus on, e.g. Ventrexia or Earth.").optional(), limit: z.number().describe("Origins or members to list, 1-20.").optional() }),
|
|
78
|
+
annotations: READ_ONLY,
|
|
79
|
+
}, async (args) => {
|
|
80
|
+
try {
|
|
81
|
+
return text(await originMap(args));
|
|
82
|
+
}
|
|
83
|
+
catch (e) {
|
|
84
|
+
return textError(error(e));
|
|
85
|
+
}
|
|
86
|
+
});
|
|
37
87
|
return server;
|
|
38
88
|
}
|
package/package.json
CHANGED