@fernforestgames/mcp-server-godot-docs 0.1.0

package/dist/handlers/tools/get-class.js

@@ -0,0 +1,52 @@
+// MCP tool handler for getting full Godot class documentation
+import { docsIndex } from '../../docs/index.js';
+import { formatClassAsText } from '../../docs/format.js';
+export async function getGodotClass({ className, }) {
+    try {
+        await docsIndex.ensureInitialized();
+        let godotClass = docsIndex.getClass(className);
+        // Try case-insensitive search if not found
+        if (!godotClass) {
+            const allClasses = docsIndex.getAllClassNames();
+            const match = allClasses.find(c => c.toLowerCase() === className.toLowerCase());
+            if (match) {
+                godotClass = docsIndex.getClass(match);
+            }
+        }
+        if (!godotClass) {
+            // Suggest similar classes
+            const allClasses = docsIndex.getAllClassNames();
+            const similar = allClasses
+                .filter(c => c.toLowerCase().includes(className.toLowerCase()) ||
+                className.toLowerCase().includes(c.toLowerCase().slice(0, 4)))
+                .slice(0, 5);
+            let errorMsg = `Class '${className}' not found.`;
+            if (similar.length > 0) {
+                errorMsg += ` Did you mean: ${similar.join(', ')}?`;
+            }
+            errorMsg += ' Use search_godot_docs to find the correct class name.';
+            return {
+                content: [{
+                        type: "text",
+                        text: errorMsg
+                    }]
+            };
+        }
+        return {
+            content: [{
+                    type: "text",
+                    text: formatClassAsText(godotClass)
+                }]
+        };
+    }
+    catch (error) {
+        const message = error instanceof Error ? error.message : 'Unknown error';
+        return {
+            content: [{
+                    type: "text",
+                    text: `Failed to get class documentation: ${message}`
+                }]
+        };
+    }
+}
+//# sourceMappingURL=get-class.js.map

package/dist/handlers/tools/get-class.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-class.js","sourceRoot":"","sources":["../../../src/handlers/tools/get-class.ts"],"names":[],"mappings":"AAAA,8DAA8D;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAEzD,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,EAClC,SAAS,GAGV;IACC,IAAI,CAAC;QACH,MAAM,SAAS,CAAC,iBAAiB,EAAE,CAAC;QAEpC,IAAI,UAAU,GAAG,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QAE/C,2CAA2C;QAC3C,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,MAAM,UAAU,GAAG,SAAS,CAAC,gBAAgB,EAAE,CAAC;YAChD,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,KAAK,SAAS,CAAC,WAAW,EAAE,CAAC,CAAC;YAEhF,IAAI,KAAK,EAAE,CAAC;gBACV,UAAU,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YACzC,CAAC;QACH,CAAC;QAED,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,0BAA0B;YAC1B,MAAM,UAAU,GAAG,SAAS,CAAC,gBAAgB,EAAE,CAAC;YAChD,MAAM,OAAO,GAAG,UAAU;iBACvB,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC;gBACjD,SAAS,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;iBAC1E,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YAEf,IAAI,QAAQ,GAAG,UAAU,SAAS,cAAc,CAAC;YACjD,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACvB,QAAQ,IAAI,kBAAkB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;YACtD,CAAC;YACD,QAAQ,IAAI,wDAAwD,CAAC;YAErE,OAAO;gBACL,OAAO,EAAE,CAAC;wBACR,IAAI,EAAE,MAAe;wBACrB,IAAI,EAAE,QAAQ;qBACf,CAAC;aACH,CAAC;QACJ,CAAC;QAED,OAAO;YACL,OAAO,EAAE,CAAC;oBACR,IAAI,EAAE,MAAe;oBACrB,IAAI,EAAE,iBAAiB,CAAC,UAAU,CAAC;iBACpC,CAAC;SACH,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC;QACzE,OAAO;YACL,OAAO,EAAE,CAAC;oBACR,IAAI,EAAE,MAAe;oBACrB,IAAI,EAAE,sCAAsC,OAAO,EAAE;iBACtD,CAAC;SACH,CAAC;IACJ,CAAC;AACH,CAAC"}

package/dist/handlers/tools/search-docs.d.ts

@@ -0,0 +1,10 @@
+export declare function searchGodotDocs({ query, limit, }: {
+    query: string;
+    limit?: number;
+}): Promise<{
+    content: {
+        type: "text";
+        text: string;
+    }[];
+}>;
+//# sourceMappingURL=search-docs.d.ts.map

package/dist/handlers/tools/search-docs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"search-docs.d.ts","sourceRoot":"","sources":["../../../src/handlers/tools/search-docs.ts"],"names":[],"mappings":"AAuBA,wBAAsB,eAAe,CAAC,EACpC,KAAK,EACL,KAAU,GACX,EAAE;IACD,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;;;;;GA2CA"}

package/dist/handlers/tools/search-docs.js

@@ -0,0 +1,62 @@
+// MCP tool handler for searching Godot documentation
+import { searchDocs } from '../../docs/search.js';
+/**
+ * Strip BBCode and clean up excerpt text
+ */
+function cleanExcerpt(text) {
+    return text
+        .replace(/\[code\](.*?)\[\/code\]/g, '`$1`')
+        .replace(/\[codeblock\][\s\S]*?\[\/codeblock\]/g, '')
+        .replace(/\[param\s+(\w+)\]/g, '`$1`')
+        .replace(/\[method\s+(\w+)\]/g, '`$1()`')
+        .replace(/\[member\s+(\w+)\]/g, '`$1`')
+        .replace(/\[signal\s+(\w+)\]/g, '`$1`')
+        .replace(/\[constant\s+([^\]]+)\]/g, '`$1`')
+        .replace(/\[[^\]]+\]/g, '')
+        .replace(/\t+/g, ' ')
+        .replace(/\n+/g, ' ')
+        .replace(/\s+/g, ' ')
+        .trim()
+        .slice(0, 150);
+}
+export async function searchGodotDocs({ query, limit = 10, }) {
+    try {
+        const results = await searchDocs(query, limit);
+        if (results.length === 0) {
+            return {
+                content: [{
+                        type: "text",
+                        text: `No results found for "${query}".`
+                    }]
+            };
+        }
+        // Format as compact text
+        const lines = [`Found ${results.length} result(s) for "${query}":\n`];
+        for (const r of results) {
+            const prefix = r.matchType === 'class' ? '' : `${r.className}.`;
+            const typeLabel = r.matchType.charAt(0).toUpperCase() + r.matchType.slice(1);
+            const excerpt = cleanExcerpt(r.excerpt);
+            lines.push(`[${typeLabel}] ${prefix}${r.name}`);
+            if (excerpt) {
+                lines.push(`  ${excerpt}`);
+            }
+            lines.push('');
+        }
+        return {
+            content: [{
+                    type: "text",
+                    text: lines.join('\n').trim()
+                }]
+        };
+    }
+    catch (error) {
+        const message = error instanceof Error ? error.message : 'Unknown error';
+        return {
+            content: [{
+                    type: "text",
+                    text: `Failed to search documentation: ${message}`
+                }]
+        };
+    }
+}
+//# sourceMappingURL=search-docs.js.map

package/dist/handlers/tools/search-docs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"search-docs.js","sourceRoot":"","sources":["../../../src/handlers/tools/search-docs.ts"],"names":[],"mappings":"AAAA,qDAAqD;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAElD;;GAEG;AACH,SAAS,YAAY,CAAC,IAAY;IAChC,OAAO,IAAI;SACR,OAAO,CAAC,0BAA0B,EAAE,MAAM,CAAC;SAC3C,OAAO,CAAC,uCAAuC,EAAE,EAAE,CAAC;SACpD,OAAO,CAAC,oBAAoB,EAAE,MAAM,CAAC;SACrC,OAAO,CAAC,qBAAqB,EAAE,QAAQ,CAAC;SACxC,OAAO,CAAC,qBAAqB,EAAE,MAAM,CAAC;SACtC,OAAO,CAAC,qBAAqB,EAAE,MAAM,CAAC;SACtC,OAAO,CAAC,0BAA0B,EAAE,MAAM,CAAC;SAC3C,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC;SAC1B,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC;SACpB,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC;SACpB,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC;SACpB,IAAI,EAAE;SACN,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;AACnB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,EACpC,KAAK,EACL,KAAK,GAAG,EAAE,GAIX;IACC,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,UAAU,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAE/C,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO;gBACL,OAAO,EAAE,CAAC;wBACR,IAAI,EAAE,MAAe;wBACrB,IAAI,EAAE,yBAAyB,KAAK,IAAI;qBACzC,CAAC;aACH,CAAC;QACJ,CAAC;QAED,yBAAyB;QACzB,MAAM,KAAK,GAAa,CAAC,SAAS,OAAO,CAAC,MAAM,mBAAmB,KAAK,MAAM,CAAC,CAAC;QAEhF,KAAK,MAAM,CAAC,IAAI,OAAO,EAAE,CAAC;YACxB,MAAM,MAAM,GAAG,CAAC,CAAC,SAAS,KAAK,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,SAAS,GAAG,CAAC;YAChE,MAAM,SAAS,GAAG,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAC7E,MAAM,OAAO,GAAG,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;YAExC,KAAK,CAAC,IAAI,CAAC,IAAI,SAAS,KAAK,MAAM,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;YAChD,IAAI,OAAO,EAAE,CAAC;gBACZ,KAAK,CAAC,IAAI,CAAC,KAAK,OAAO,EAAE,CAAC,CAAC;YAC7B,CAAC;YACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACjB,CAAC;QAED,OAAO;YACL,OAAO,EAAE,CAAC;oBACR,IAAI,EAAE,MAAe;oBACrB,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE;iBAC9B,CAAC;SACH,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC;QACzE,OAAO;YACL,OAAO,EAAE,CAAC;oBACR,IAAI,EAAE,MAAe;oBACrB,IAAI,EAAE,mCAAmC,OAAO,EAAE;iBACnD,CAAC;SACH,CAAC;IACJ,CAAC;AACH,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+import "./config.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAIA,OAAO,aAAa,CAAC"}

package/dist/index.js

@@ -0,0 +1,31 @@
+#!/usr/bin/env node
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
+import { z } from "zod";
+import "./config.js"; // Validate configuration on startup
+import { searchGodotDocs } from "./handlers/tools/search-docs.js";
+import { getGodotClass } from "./handlers/tools/get-class.js";
+const server = new McpServer({
+    name: "mcp-server-godot-docs",
+    version: "0.4.0",
+});
+// Documentation search tools
+server.registerTool("search_godot_docs", {
+    title: "Search Godot Documentation",
+    description: "Search the Godot engine documentation for classes, methods, properties, signals, and constants. On first use, downloads docs matching your Godot version.",
+    inputSchema: {
+        query: z.string().describe("Search query (class name, method name, or keyword)"),
+        limit: z.number().default(10).describe("Maximum number of results to return")
+    }
+}, searchGodotDocs);
+server.registerTool("get_godot_class", {
+    title: "Get Godot Class Documentation",
+    description: "Get the full documentation for a specific Godot class, including all methods, properties, signals, and constants.",
+    inputSchema: {
+        className: z.string().describe("Exact class name (e.g., 'RigidBody3D', 'Node', 'Control')")
+    }
+}, getGodotClass);
+// Start receiving messages on stdin and sending messages on stdout
+const transport = new StdioServerTransport();
+await server.connect(transport);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AACpE,OAAO,EAAE,oBAAoB,EAAE,MAAM,2CAA2C,CAAC;AACjF,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,aAAa,CAAC,CAAC,oCAAoC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAClE,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAE9D,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC;IAC3B,IAAI,EAAE,uBAAuB;IAC7B,OAAO,EAAE,OAAO;CACjB,CAAC,CAAC;AAEH,6BAA6B;AAC7B,MAAM,CAAC,YAAY,CAAC,mBAAmB,EACrC;IACE,KAAK,EAAE,4BAA4B;IACnC,WAAW,EAAE,2JAA2J;IACxK,WAAW,EAAE;QACX,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,oDAAoD,CAAC;QAChF,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,qCAAqC,CAAC;KAC9E;CACF,EACD,eAAe,CAChB,CAAC;AAEF,MAAM,CAAC,YAAY,CAAC,iBAAiB,EACnC;IACE,KAAK,EAAE,+BAA+B;IACtC,WAAW,EAAE,mHAAmH;IAChI,WAAW,EAAE;QACX,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,2DAA2D,CAAC;KAC5F;CACF,EACD,aAAa,CACd,CAAC;AAEF,mEAAmE;AACnE,MAAM,SAAS,GAAG,IAAI,oBAAoB,EAAE,CAAC;AAC7C,MAAM,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@fernforestgames/mcp-server-godot-docs",
+  "version": "0.1.0",
+  "description": "MCP server to help agents search Godot engine documentation",
+  "author": "Justin Spahr-Summers <justin@fernforestgames.com> (https://fernforestgames.com)",
+  "license": "MIT",
+  "homepage": "https://github.com/fernforestgames/mcp-server-godot-docs",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/fernforestgames/mcp-server-godot-docs.git"
+  },
+  "type": "module",
+  "scripts": {
+    "build": "tsc && shx chmod +x dist/*.js",
+    "dev": "tsx src/index.ts",
+    "start": "node dist/index.js",
+    "lint": "eslint src/**/*.ts"
+  },
+  "bin": {
+    "mcp-server-godot-docs": "dist/index.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "mcp",
+    "godot",
+    "documentation",
+    "typescript"
+  ],
+  "engines": {
+    "node": ">=22.0.0"
+  },
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.0.0",
+    "dotenv": "^17.2.3",
+    "env-paths": "^3.0.0",
+    "fast-xml-parser": "^5.3.3",
+    "tar": "^7.5.2"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.36.0",
+    "@types/node": "^24.5.2",
+    "@typescript-eslint/eslint-plugin": "^8.44.1",
+    "@typescript-eslint/parser": "^8.44.1",
+    "eslint": "^9.36.0",
+    "globals": "^16.4.0",
+    "shx": "^0.4.0",
+    "tsx": "^4.20.6",
+    "typescript": "^5.9.2"
+  }
+}