codewars-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.d.ts +15 -0
- package/dist/api.js +48 -0
- package/dist/gateway.d.ts +16 -0
- package/dist/gateway.js +85 -0
- package/dist/server.js +72 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -22,3 +22,22 @@ The server uses stdio, so it can be connected to Claude Desktop, Cursor, VS Code
|
|
|
22
22
|
## Limits and privacy
|
|
23
23
|
|
|
24
24
|
This project is intentionally narrow. It should be treated as a practical helper, not a complete certification or security audit. Check the implementation and the returned data before using it with sensitive material. No credentials are required.
|
|
25
|
+
|
|
26
|
+
<!-- paywall -->
|
|
27
|
+
## Premium tools
|
|
28
|
+
|
|
29
|
+
These tools need a licence key:
|
|
30
|
+
|
|
31
|
+
* `language_progress`
|
|
32
|
+
* `completion_timeline`
|
|
33
|
+
|
|
34
|
+
The tool bodies run on our gateway, not inside this package, so the key is what buys access. Buy one at https://buy.polar.sh/polar_cl_mrO7rS5LZxpqM7oAFFEA10i9121J240U40IIj4JRZO4 and set it in your MCP client config:
|
|
35
|
+
|
|
36
|
+
```json
|
|
37
|
+
"env": { "MCP_LICENSE_KEY": "polar_..." }
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
The gateway checks the key against Polar and gives every key 1,000 free premium
|
|
41
|
+
calls a month before per-call billing starts. Every other tool on this server
|
|
42
|
+
stays free.
|
|
43
|
+
<!-- /paywall -->
|
package/dist/api.d.ts
CHANGED
|
@@ -19,3 +19,18 @@ export interface Kata {
|
|
|
19
19
|
export declare function getKata(idOrSlug: string): Promise<Kata>;
|
|
20
20
|
export declare function formatUser(u: Codewarrior): string;
|
|
21
21
|
export declare function formatKata(k: Kata): string;
|
|
22
|
+
export interface CompletedArgs {
|
|
23
|
+
username: string;
|
|
24
|
+
page?: number;
|
|
25
|
+
limit?: number;
|
|
26
|
+
}
|
|
27
|
+
export interface ProgressArgs {
|
|
28
|
+
username: string;
|
|
29
|
+
limit?: number;
|
|
30
|
+
}
|
|
31
|
+
export interface LanguageFilterArgs {
|
|
32
|
+
filter?: string;
|
|
33
|
+
limit?: number;
|
|
34
|
+
}
|
|
35
|
+
export declare function completedKata(args: CompletedArgs): Promise<string>;
|
|
36
|
+
export declare function supportedLanguages(args: LanguageFilterArgs): Promise<string>;
|
package/dist/api.js
CHANGED
|
@@ -61,3 +61,51 @@ export function formatUser(u) {
|
|
|
61
61
|
export function formatKata(k) {
|
|
62
62
|
return `[${k.id ?? "?"}] ${k.name ?? "(unnamed)"}${k.rank ? ` (${k.rank})` : ""}${k.tags.length ? `\nTags: ${k.tags.join(", ")}` : ""}`;
|
|
63
63
|
}
|
|
64
|
+
/** Checked the same way the existing tools check a username. */
|
|
65
|
+
function username(value) {
|
|
66
|
+
const name = (value ?? "").trim();
|
|
67
|
+
if (!/^[\w-]+$/.test(name))
|
|
68
|
+
throw new CodewarsError(`Not a username: "${value}".`);
|
|
69
|
+
return name;
|
|
70
|
+
}
|
|
71
|
+
/** One page of a user's completed kata, most recent first. */
|
|
72
|
+
async function completedPage(name, page) {
|
|
73
|
+
const suffix = page > 1 ? `?page=${page}` : "";
|
|
74
|
+
return getJson(`/users/${encodeURIComponent(name)}/code-challenges/completed${suffix}`);
|
|
75
|
+
}
|
|
76
|
+
export async function completedKata(args) {
|
|
77
|
+
const name = username(args.username);
|
|
78
|
+
const page = Math.max(1, Math.min(Math.round(args.page ?? 1), 50));
|
|
79
|
+
const limit = Math.max(1, Math.min(Math.round(args.limit ?? 10), 50));
|
|
80
|
+
const d = await completedPage(name, page);
|
|
81
|
+
const rows = d.data ?? [];
|
|
82
|
+
if (!rows.length)
|
|
83
|
+
return `${name} has no completed kata.`;
|
|
84
|
+
const shown = rows.slice(0, limit);
|
|
85
|
+
return [
|
|
86
|
+
`Completed kata for ${name}: ${d.totalItems ?? rows.length} in total over ${d.totalPages ?? 1} page(s), page ${page}${rows.length > shown.length ? `, first ${shown.length} listed` : ""}.`,
|
|
87
|
+
...shown.map((r, i) => {
|
|
88
|
+
const when = (r.completedAt ?? "").slice(0, 10);
|
|
89
|
+
const langs = r.completedLanguages ?? [];
|
|
90
|
+
return `${i + 1}. ${r.name ?? "unnamed"} [${r.slug ?? "?"}]${when ? ` - ${when}` : ""}${langs.length ? ` (${langs.join(", ")})` : ""}`;
|
|
91
|
+
}),
|
|
92
|
+
].join("\n");
|
|
93
|
+
}
|
|
94
|
+
export async function supportedLanguages(args) {
|
|
95
|
+
const filter = (args.filter ?? "").trim().toLowerCase();
|
|
96
|
+
const limit = Math.max(1, Math.min(Math.round(args.limit ?? 25), 58));
|
|
97
|
+
const d = await getJson("/languages");
|
|
98
|
+
const rows = d.data ?? [];
|
|
99
|
+
if (!rows.length)
|
|
100
|
+
return "Codewars reported no languages.";
|
|
101
|
+
const matched = filter
|
|
102
|
+
? rows.filter((r) => `${r.name ?? ""} ${r.id ?? ""}`.toLowerCase().includes(filter))
|
|
103
|
+
: rows;
|
|
104
|
+
if (!matched.length)
|
|
105
|
+
return `No Codewars language matches "${filter}".`;
|
|
106
|
+
const shown = matched.slice(0, limit);
|
|
107
|
+
return [
|
|
108
|
+
`${matched.length} of the ${rows.length} languages Codewars supports${filter ? ` match "${filter}"` : ""}${matched.length > shown.length ? `, first ${shown.length} shown` : ""}:`,
|
|
109
|
+
...shown.map((r, i) => `${i + 1}. ${r.name ?? "?"} (id ${r.id ?? "?"})`),
|
|
110
|
+
].join("\n");
|
|
111
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Thin client for the premium gateway.
|
|
3
|
+
*
|
|
4
|
+
* The premium tools do not run in this package any more. Their bodies live on
|
|
5
|
+
* the gateway, which checks a Polar licence key before it does any work, so
|
|
6
|
+
* deleting anything here buys nothing: the answer only exists behind the gate.
|
|
7
|
+
*
|
|
8
|
+
* Set `MCP_LICENSE_KEY` to a Polar licence key. `MCP_GATEWAY_URL` overrides the
|
|
9
|
+
* endpoint, which is only useful for testing.
|
|
10
|
+
*/
|
|
11
|
+
/** Raised when a premium call cannot be completed. `message` is safe to show. */
|
|
12
|
+
export declare class GatewayError extends Error {
|
|
13
|
+
readonly refused: boolean;
|
|
14
|
+
constructor(message: string, refused: boolean);
|
|
15
|
+
}
|
|
16
|
+
export declare function premiumTool(tool: string, args: Record<string, unknown>): Promise<string>;
|
package/dist/gateway.js
ADDED
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Thin client for the premium gateway.
|
|
3
|
+
*
|
|
4
|
+
* The premium tools do not run in this package any more. Their bodies live on
|
|
5
|
+
* the gateway, which checks a Polar licence key before it does any work, so
|
|
6
|
+
* deleting anything here buys nothing: the answer only exists behind the gate.
|
|
7
|
+
*
|
|
8
|
+
* Set `MCP_LICENSE_KEY` to a Polar licence key. `MCP_GATEWAY_URL` overrides the
|
|
9
|
+
* endpoint, which is only useful for testing.
|
|
10
|
+
*/
|
|
11
|
+
const DEFAULT_GATEWAY_URL = 'https://mcp-gateway.contactae2000.workers.dev/mcp';
|
|
12
|
+
const DEFAULT_TIMEOUT_MS = 25000;
|
|
13
|
+
const USER_AGENT = 'mrfentmen-mcp/1.0';
|
|
14
|
+
/** Raised when a premium call cannot be completed. `message` is safe to show. */
|
|
15
|
+
export class GatewayError extends Error {
|
|
16
|
+
refused;
|
|
17
|
+
constructor(message, refused) {
|
|
18
|
+
super(message);
|
|
19
|
+
this.refused = refused;
|
|
20
|
+
this.name = 'GatewayError';
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
export async function premiumTool(tool, args) {
|
|
24
|
+
const key = (process.env.MCP_LICENSE_KEY ?? '').trim();
|
|
25
|
+
if (!key) {
|
|
26
|
+
throw new GatewayError(`"${tool}" is a premium tool and no licence key is set. Set MCP_LICENSE_KEY in your MCP client config.`, true);
|
|
27
|
+
}
|
|
28
|
+
const url = (process.env.MCP_GATEWAY_URL ?? DEFAULT_GATEWAY_URL).trim();
|
|
29
|
+
const controller = new AbortController();
|
|
30
|
+
const timer = setTimeout(() => controller.abort(), DEFAULT_TIMEOUT_MS);
|
|
31
|
+
let response;
|
|
32
|
+
try {
|
|
33
|
+
response = await fetch(url, {
|
|
34
|
+
method: 'POST',
|
|
35
|
+
headers: {
|
|
36
|
+
'content-type': 'application/json',
|
|
37
|
+
accept: 'application/json',
|
|
38
|
+
'user-agent': USER_AGENT,
|
|
39
|
+
authorization: `Bearer ${key}`,
|
|
40
|
+
},
|
|
41
|
+
body: JSON.stringify({
|
|
42
|
+
jsonrpc: '2.0',
|
|
43
|
+
id: 1,
|
|
44
|
+
method: 'tools/call',
|
|
45
|
+
params: { name: tool, arguments: args },
|
|
46
|
+
}),
|
|
47
|
+
signal: controller.signal,
|
|
48
|
+
});
|
|
49
|
+
}
|
|
50
|
+
catch {
|
|
51
|
+
throw new GatewayError(`"${tool}" could not reach the licence gateway. Check your connection and try again.`, false);
|
|
52
|
+
}
|
|
53
|
+
finally {
|
|
54
|
+
clearTimeout(timer);
|
|
55
|
+
}
|
|
56
|
+
if (!response.ok) {
|
|
57
|
+
throw new GatewayError(`"${tool}" could not reach the licence gateway (HTTP ${response.status}).`, false);
|
|
58
|
+
}
|
|
59
|
+
let body;
|
|
60
|
+
try {
|
|
61
|
+
body = (await response.json());
|
|
62
|
+
}
|
|
63
|
+
catch {
|
|
64
|
+
throw new GatewayError(`"${tool}" got an unreadable answer from the licence gateway.`, false);
|
|
65
|
+
}
|
|
66
|
+
if (body.error) {
|
|
67
|
+
throw new GatewayError(`"${tool}" was refused by the licence gateway: ${body.error.message ?? 'unknown error'}`, false);
|
|
68
|
+
}
|
|
69
|
+
const result = body.result ?? {};
|
|
70
|
+
const text = (result.content ?? [])
|
|
71
|
+
.map((part) => part.text ?? '')
|
|
72
|
+
.join('\n')
|
|
73
|
+
.trim();
|
|
74
|
+
if (result.isError) {
|
|
75
|
+
// The gateway marks a licence refusal structurally, so a missing or rejected
|
|
76
|
+
// key is told apart from a tool that failed after the gate let it through.
|
|
77
|
+
if (result.structuredContent?.licenceRefusal) {
|
|
78
|
+
throw new GatewayError(text || `"${tool}" needs a valid licence key.`, true);
|
|
79
|
+
}
|
|
80
|
+
throw new GatewayError(text || `"${tool}" failed on the licence gateway.`, false);
|
|
81
|
+
}
|
|
82
|
+
if (!text)
|
|
83
|
+
throw new GatewayError(`"${tool}" returned no data.`, false);
|
|
84
|
+
return text;
|
|
85
|
+
}
|
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 { CodewarsError, formatKata, formatUser, getKata, getUser } from "./api.js";
|
|
3
|
+
import { CodewarsError, formatKata, formatUser, getKata, getUser, completedKata, supportedLanguages } from "./api.js";
|
|
4
|
+
import { premiumTool } from "./gateway.js";
|
|
4
5
|
const text = (t) => ({ content: [{ type: "text", text: t }] });
|
|
5
6
|
const textError = (t) => ({ content: [{ type: "text", text: t }], isError: true });
|
|
6
7
|
const READ_ONLY = { readOnlyHint: true, openWorldHint: true };
|
|
@@ -39,6 +40,76 @@ export function createServer() {
|
|
|
39
40
|
return textError(errorMessage(e));
|
|
40
41
|
}
|
|
41
42
|
});
|
|
43
|
+
server.registerTool("completed_kata", {
|
|
44
|
+
title: "Completed kata",
|
|
45
|
+
description: "The kata a Codewars user has completed, most recent first, with the language and date for each and the total count.",
|
|
46
|
+
inputSchema: z.object({
|
|
47
|
+
username: z.string().describe("Codewars username"),
|
|
48
|
+
page: z.number().describe("Which page of 200 to read, 1-50").optional(),
|
|
49
|
+
limit: z.number().describe("Max kata to list, 1-50").optional(),
|
|
50
|
+
}),
|
|
51
|
+
annotations: READ_ONLY,
|
|
52
|
+
}, async (args) => {
|
|
53
|
+
try {
|
|
54
|
+
return text(await completedKata(args));
|
|
55
|
+
}
|
|
56
|
+
catch (e) {
|
|
57
|
+
return textError(errorMessage(e));
|
|
58
|
+
}
|
|
59
|
+
});
|
|
60
|
+
server.registerTool("language_progress", {
|
|
61
|
+
title: "Language progress",
|
|
62
|
+
description: "Which languages a Codewars user's recent completed kata are written in, ranked by how many, with the most recent date in each.",
|
|
63
|
+
inputSchema: z.object({
|
|
64
|
+
username: z.string().describe("Codewars username"),
|
|
65
|
+
limit: z.number().describe("Max languages to list, 1-30").optional(),
|
|
66
|
+
}),
|
|
67
|
+
annotations: READ_ONLY,
|
|
68
|
+
}, async (args) => {
|
|
69
|
+
// ---- paywall: language_progress ----
|
|
70
|
+
// The body runs on the gateway, behind the licence gate.
|
|
71
|
+
// ---- paywall: end ----
|
|
72
|
+
try {
|
|
73
|
+
return text(await premiumTool("mcp_codewars_language_progress", args));
|
|
74
|
+
}
|
|
75
|
+
catch (e) {
|
|
76
|
+
return textError(errorMessage(e));
|
|
77
|
+
}
|
|
78
|
+
});
|
|
79
|
+
server.registerTool("completion_timeline", {
|
|
80
|
+
title: "Completion timeline",
|
|
81
|
+
description: "How many kata a Codewars user completed in each year, taken from their most recent completions.",
|
|
82
|
+
inputSchema: z.object({
|
|
83
|
+
username: z.string().describe("Codewars username"),
|
|
84
|
+
}),
|
|
85
|
+
annotations: READ_ONLY,
|
|
86
|
+
}, async (args) => {
|
|
87
|
+
// ---- paywall: completion_timeline ----
|
|
88
|
+
// The body runs on the gateway, behind the licence gate.
|
|
89
|
+
// ---- paywall: end ----
|
|
90
|
+
try {
|
|
91
|
+
return text(await premiumTool("mcp_codewars_completion_timeline", args));
|
|
92
|
+
}
|
|
93
|
+
catch (e) {
|
|
94
|
+
return textError(errorMessage(e));
|
|
95
|
+
}
|
|
96
|
+
});
|
|
97
|
+
server.registerTool("supported_languages", {
|
|
98
|
+
title: "Supported languages",
|
|
99
|
+
description: "The languages Codewars supports, optionally filtered by name, with the id the API uses for each.",
|
|
100
|
+
inputSchema: z.object({
|
|
101
|
+
filter: z.string().describe("Substring to match against language name or id").optional(),
|
|
102
|
+
limit: z.number().describe("Max languages to list, 1-58").optional(),
|
|
103
|
+
}),
|
|
104
|
+
annotations: READ_ONLY,
|
|
105
|
+
}, async (args) => {
|
|
106
|
+
try {
|
|
107
|
+
return text(await supportedLanguages(args));
|
|
108
|
+
}
|
|
109
|
+
catch (e) {
|
|
110
|
+
return textError(errorMessage(e));
|
|
111
|
+
}
|
|
112
|
+
});
|
|
42
113
|
return server;
|
|
43
114
|
}
|
|
44
115
|
function errorMessage(e) {
|