@marcelo-ochoa/server-qnap 1.0.1

package/dist/tools/dir.js

@@ -0,0 +1,33 @@
+import { getNasHost, getNasSid, fetchWithTimeout } from "./connect.js";
+export async function dirHandler(request) {
+    const { path } = request.params.arguments || {};
+    const nas_host = getNasHost();
+    const nas_sid = getNasSid();
+    if (!nas_host || !nas_sid) {
+        return {
+            content: [{ type: "text", text: "Not connected to QNAP NAS. Use qnap-connect first." }],
+            isError: true
+        };
+    }
+    if (typeof path !== "string" || !path) {
+        return {
+            content: [{ type: "text", text: "Missing or invalid path argument." }],
+            isError: true,
+        };
+    }
+    try {
+        const url = `${nas_host}/cgi-bin/filemanager/utilRequest.cgi?func=get_list&path=${path}&sid=${nas_sid}&limit=100&start=0`;
+        const response = await fetchWithTimeout(url);
+        const data = await response.json();
+        return {
+            content: [{ type: "text", text: JSON.stringify(data, null, 2) }],
+            isError: false,
+        };
+    }
+    catch (error) {
+        return {
+            content: [{ type: "text", text: `Error listing directory: ${error.message}` }],
+            isError: true
+        };
+    }
+}

package/dist/tools/file_info.js

@@ -0,0 +1,33 @@
+import { getNasHost, getNasSid, fetchWithTimeout } from "./connect.js";
+export async function fileInfoHandler(request) {
+    const { path, filename } = request.params.arguments || {};
+    const nas_host = getNasHost();
+    const nas_sid = getNasSid();
+    if (!nas_host || !nas_sid) {
+        return {
+            content: [{ type: "text", text: "Not connected to QNAP NAS. Use qnap-connect first." }],
+            isError: true
+        };
+    }
+    if (typeof path !== "string" || !path || typeof filename !== "string" || !filename) {
+        return {
+            content: [{ type: "text", text: "Missing or invalid path or filename argument." }],
+            isError: true,
+        };
+    }
+    try {
+        const url = `${nas_host}/cgi-bin/filemanager/utilRequest.cgi?func=stat&sid=${nas_sid}&path=${path}&file_total=1&file_name=${filename}`;
+        const response = await fetchWithTimeout(url);
+        const text = await response.text();
+        return {
+            content: [{ type: "text", text: text }],
+            isError: false,
+        };
+    }
+    catch (error) {
+        return {
+            content: [{ type: "text", text: `Error getting file info: ${error.message}` }],
+            isError: true
+        };
+    }
+}

package/dist/tools/report.js

@@ -0,0 +1,39 @@
+import { getNasHost, getNasSid, fetchWithTimeout } from "./connect.js";
+export async function reportHandler(request) {
+    const nas_host = getNasHost();
+    const nas_sid = getNasSid();
+    if (!nas_host || !nas_sid) {
+        return {
+            content: [{ type: "text", text: "Not connected to QNAP NAS. Use qnap-connect first." }],
+            isError: true
+        };
+    }
+    try {
+        // Fetch system info to get model details
+        const dc = Date.now();
+        const url = `${nas_host}/cgi-bin/sys/sysRequest.cgi?subfunc=sys_info&sid=${nas_sid}&_dc=${dc}`;
+        const response = await fetchWithTimeout(url);
+        const text = await response.text();
+        const modelMatch = text.match(/<displayModelName><!\[CDATA\[([^\]]*)\]\]><\/displayModelName>/);
+        const modelName = modelMatch ? modelMatch[1] : "Unknown QNAP Model";
+        // Extract IP from host
+        const hostUrl = new URL(nas_host);
+        const report = [
+            `### QNAP Connection Report`,
+            `- **Model Name**: ${modelName}`,
+            `- **IP Address**: ${hostUrl.hostname}`,
+            `- **Connected User**: ${process.env.QNAP_USER || "admin"}`,
+            `- **Access URL**: ${nas_host}`
+        ].join('\n');
+        return {
+            content: [{ type: "text", text: report }],
+            isError: false,
+        };
+    }
+    catch (error) {
+        return {
+            content: [{ type: "text", text: `Error generating report: ${error.message}` }],
+            isError: true
+        };
+    }
+}

package/dist/tools.js

@@ -0,0 +1,65 @@
+export const tools = [
+    {
+        name: "qnap-connect",
+        description: "Connect to a QNAP NAS and obtain a session ID.",
+        inputSchema: {
+            type: "object",
+            properties: {
+                host: {
+                    type: "string",
+                    description: "QNAP NAS host (e.g., http://10.1.1.241:8080)"
+                },
+                username: {
+                    type: "string",
+                    description: "Username"
+                },
+                password: {
+                    type: "string",
+                    description: "Password"
+                }
+            },
+            required: ["host", "username", "password"]
+        }
+    },
+    {
+        name: "qnap-report",
+        description: "Generate a QNAP system report including CPU, memory, disks and volume status.",
+        inputSchema: {
+            type: "object",
+            properties: {},
+            required: []
+        }
+    },
+    {
+        name: "qnap-dir",
+        description: "List contents of a directory on the QNAP NAS.",
+        inputSchema: {
+            type: "object",
+            properties: {
+                path: {
+                    type: "string",
+                    description: "Directory path (e.g., /Public)"
+                }
+            },
+            required: ["path"]
+        }
+    },
+    {
+        name: "qnap-file-info",
+        description: "Get detailed information about a file on the QNAP NAS.",
+        inputSchema: {
+            type: "object",
+            properties: {
+                path: {
+                    type: "string",
+                    description: "Directory path where the file is located"
+                },
+                filename: {
+                    type: "string",
+                    description: "Name of the file"
+                }
+            },
+            required: ["path", "filename"]
+        }
+    }
+];

package/handlers.ts

@@ -0,0 +1,23 @@
+import { CallToolRequest } from "@modelcontextprotocol/sdk/types.js";
+import { connectHandler, initializeApi } from "./tools/connect.js";
+import { reportHandler } from "./tools/report.js";
+import { dirHandler } from "./tools/dir.js";
+import { fileInfoHandler } from "./tools/file_info.js";
+
+const toolHandlers: Record<string, (request: CallToolRequest) => Promise<any>> = {
+    "qnap-connect": connectHandler,
+    "qnap-report": reportHandler,
+    "qnap-dir": dirHandler,
+    "qnap-file-info": fileInfoHandler,
+};
+
+export const callToolHandler = async (request: CallToolRequest) => {
+    const handler = toolHandlers[request.params.name];
+    if (handler) {
+        return handler(request);
+    }
+    throw new Error(`Unknown tool: ${request.params.name}`);
+};
+
+export { initializeApi };
+

package/index.ts

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+import { QnapServer } from "./server.js";
+
+const server = new QnapServer();
+server.run().catch((error) => {
+    console.error("Fatal error running server:", error);
+    process.exit(1);
+});

package/package.json

@@ -0,0 +1,24 @@
+{
+    "name": "@marcelo-ochoa/server-qnap",
+    "mcpName": "io.github.marcelo-ochoa/qnap",
+    "version": "1.0.1",
+    "description": "An MCP server for QNAP NAS API.",
+    "type": "module",
+    "bin": {
+        "mcp-server-qnap": "dist/index.js"
+    },
+    "main": "dist/index.js",
+    "scripts": {
+        "build": "tsc && shx chmod +x dist/*.js",
+        "prepare": "npm run build",
+        "watch": "tsc --watch"
+    },
+    "dependencies": {
+        "@modelcontextprotocol/sdk": "^1.24.2"
+    },
+    "devDependencies": {
+        "@types/node": "^22",
+        "shx": "^0.3.4",
+        "typescript": "^5.6.2"
+    }
+}

package/server.json

@@ -0,0 +1,21 @@
+{
+    "$schema": "https://static.modelcontextprotocol.io/schemas/2025-12-11/server.schema.json",
+    "name": "io.github.marcelo-ochoa/qnap",
+    "description": "MCP server for QNAP NAS API",
+    "repository": {
+        "url": "https://github.com/marcelo-ochoa/servers",
+        "source": "github",
+        "subfolder": "src/qnap"
+    },
+    "version": "1.0.1",
+    "packages": [
+        {
+            "registryType": "npm",
+            "identifier": "@marcelo-ochoa/server-qnap",
+            "version": "1.0.1",
+            "transport": {
+                "type": "stdio"
+            }
+        }
+    ]
+}

package/server.ts

@@ -0,0 +1,86 @@
+import { Server } from "@modelcontextprotocol/sdk/server/index.js";
+import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
+import {
+    CallToolRequestSchema,
+    ListToolsRequestSchema,
+} from "@modelcontextprotocol/sdk/types.js";
+import { z } from "zod";
+import { tools } from "./tools.js";
+import { callToolHandler, initializeApi } from "./handlers.js";
+
+const prompts = [
+    { name: "qnap-connect: Connect to QNAP NAS", description: "connect to QNAP NAS using host, username and password" },
+    { name: "qnap-report: System Report", description: "show a comprehensive system report with CPU, memory, and disk status" },
+    { name: "qnap-dir: List Directory", description: "list contents of a directory on the QNAP NAS" },
+    { name: "qnap-file-info: File Information", description: "get detailed information about a specific file" }
+];
+
+const PromptsListRequestSchema = z.object({
+    method: z.literal("prompts/list"),
+    params: z.object({}),
+});
+
+export class QnapServer {
+    private server: Server;
+
+    constructor() {
+        this.server = new Server(
+            {
+                name: "qnap-mcp-server",
+                version: "1.0.1",
+            },
+            {
+                capabilities: {
+                    tools: {},
+                    prompts: {},
+                },
+            }
+        );
+
+        this.setupHandlers();
+
+        this.server.onerror = (error) => console.error("[MCP Error]", error);
+    }
+
+    private setupHandlers() {
+        this.server.setRequestHandler(PromptsListRequestSchema, async () => {
+            return {
+                prompts,
+            };
+        });
+
+        this.server.setRequestHandler(ListToolsRequestSchema, async () => ({
+            tools: tools,
+        }));
+
+        this.server.setRequestHandler(CallToolRequestSchema, async (request) => {
+            return await callToolHandler(request);
+        });
+    }
+
+    async run() {
+        const args = process.argv.slice(2);
+        const host = args[0];
+
+        if (host) {
+            try {
+                await initializeApi(host);
+                console.error(`Automatically connected to QNAP NAS at ${host}`);
+            } catch (error: any) {
+                console.error(`Failed to automatically connect to QNAP NAS: ${error.message}`);
+            }
+        } else {
+            console.error("Warning: No QNAP host provided as argument. Use qnap-connect tool before using other functionality.");
+        }
+
+        const transport = new StdioServerTransport();
+        await this.server.connect(transport);
+        console.error("QNAP MCP server running on stdio");
+
+        process.stdin.on("close", () => {
+            console.error("QNAP MCP Server closed");
+            this.server.close();
+            process.exit(0);
+        });
+    }
+}

package/tools/connect.ts

@@ -0,0 +1,126 @@
+import { CallToolRequest } from "@modelcontextprotocol/sdk/types.js";
+
+let nas_host: string | null = null;
+let nas_sid: string | null = null;
+
+export function getNasHost(): string | null {
+    return nas_host;
+}
+
+export function getNasSid(): string | null {
+    return nas_sid;
+}
+
+export function setNasConnection(host: string, sid: string): void {
+    nas_host = host;
+    nas_sid = sid;
+}
+
+export function clearNasConnection(): void {
+    nas_host = null;
+    nas_sid = null;
+}
+
+export async function initializeApi(host: string, username?: string, password?: string) {
+    const user = username || process.env.QNAP_USER;
+    const pwd = password || process.env.QNAP_PASSWORD;
+
+    if (!user || !pwd) {
+        throw new Error("Credentials not provided and QNAP_USER/QNAP_PASSWORD env variables not set.");
+    }
+
+    // Directly perform the connection logic
+    const b64_pwd = Buffer.from(pwd).toString('base64');
+    const url = `${host}/cgi-bin/authLogin.cgi?user=${user}&pwd=${b64_pwd}`;
+
+    try {
+        const response = await fetchWithTimeout(url);
+        const text = await response.text();
+
+        // Extract SID using regex
+        const sidMatch = text.match(/<authSid><!\[CDATA\[([^\]]*)\]\]><\/authSid>/);
+        const sid = sidMatch ? sidMatch[1] : null;
+
+        if (sid) {
+            setNasConnection(host, sid);
+        } else {
+            throw new Error(`Login failed. Response: ${text}`);
+        }
+    } catch (error: any) {
+        throw new Error(`Error connecting to QNAP: ${error.message}`);
+    }
+}
+
+async function fetchWithTimeout(url: string, options: any = {}, timeout = 60000) {
+    const controller = new AbortController();
+    const id = setTimeout(() => controller.abort(), timeout);
+
+    const headers = {
+        ...options.headers,
+        'Referer': nas_host ? `${nas_host}/cgi-bin/index.cgi` : '',
+    };
+
+    if (nas_sid) {
+        (headers as any)['Cookie'] = `NAS_SID=${nas_sid}`;
+    }
+
+    try {
+        const response = await fetch(url, {
+            ...options,
+            headers,
+            signal: controller.signal
+        });
+        clearTimeout(id);
+        return response;
+    } catch (error) {
+        clearTimeout(id);
+        throw error;
+    }
+}
+
+export async function connectHandler(request: CallToolRequest) {
+    const { host, username, password } = request.params.arguments || {};
+
+    if (
+        typeof host !== "string" || !host ||
+        typeof username !== "string" || !username ||
+        typeof password !== "string" || !password
+    ) {
+        return {
+            content: [{ type: "text", text: "Missing or invalid host, username, or password argument." }],
+            isError: true,
+        };
+    }
+
+    const b64_pwd = Buffer.from(password).toString('base64');
+    const url = `${host}/cgi-bin/authLogin.cgi?user=${username}&pwd=${b64_pwd}`;
+
+    try {
+        const response = await fetchWithTimeout(url);
+        const text = await response.text();
+
+        // Extract SID using regex
+        const sidMatch = text.match(/<authSid><!\[CDATA\[([^\]]*)\]\]><\/authSid>/);
+        const sid = sidMatch ? sidMatch[1] : null;
+
+        if (sid) {
+            setNasConnection(host, sid);
+            return {
+                content: [{ type: "text", text: `Connected successfully to ${host}. SID: ${sid}` }],
+                isError: false,
+            };
+        } else {
+            return {
+                content: [{ type: "text", text: `Login failed. Response: ${text}` }],
+                isError: true
+            };
+        }
+    } catch (error: any) {
+        return {
+            content: [{ type: "text", text: `Error connecting to QNAP: ${error.message}` }],
+            isError: true
+        };
+    }
+}
+
+export { fetchWithTimeout };

package/tools/dir.ts

@@ -0,0 +1,38 @@
+import { CallToolRequest } from "@modelcontextprotocol/sdk/types.js";
+import { getNasHost, getNasSid, fetchWithTimeout } from "./connect.js";
+
+export async function dirHandler(request: CallToolRequest) {
+    const { path } = request.params.arguments || {};
+    const nas_host = getNasHost();
+    const nas_sid = getNasSid();
+
+    if (!nas_host || !nas_sid) {
+        return {
+            content: [{ type: "text", text: "Not connected to QNAP NAS. Use qnap-connect first." }],
+            isError: true
+        };
+    }
+
+    if (typeof path !== "string" || !path) {
+        return {
+            content: [{ type: "text", text: "Missing or invalid path argument." }],
+            isError: true,
+        };
+    }
+
+    try {
+        const url = `${nas_host}/cgi-bin/filemanager/utilRequest.cgi?func=get_list&path=${path}&sid=${nas_sid}&limit=100&start=0`;
+        const response = await fetchWithTimeout(url);
+        const data = await response.json();
+
+        return {
+            content: [{ type: "text", text: JSON.stringify(data, null, 2) }],
+            isError: false,
+        };
+    } catch (error: any) {
+        return {
+            content: [{ type: "text", text: `Error listing directory: ${error.message}` }],
+            isError: true
+        };
+    }
+}

package/tools/file_info.ts

@@ -0,0 +1,38 @@
+import { CallToolRequest } from "@modelcontextprotocol/sdk/types.js";
+import { getNasHost, getNasSid, fetchWithTimeout } from "./connect.js";
+
+export async function fileInfoHandler(request: CallToolRequest) {
+    const { path, filename } = request.params.arguments || {};
+    const nas_host = getNasHost();
+    const nas_sid = getNasSid();
+
+    if (!nas_host || !nas_sid) {
+        return {
+            content: [{ type: "text", text: "Not connected to QNAP NAS. Use qnap-connect first." }],
+            isError: true
+        };
+    }
+
+    if (typeof path !== "string" || !path || typeof filename !== "string" || !filename) {
+        return {
+            content: [{ type: "text", text: "Missing or invalid path or filename argument." }],
+            isError: true,
+        };
+    }
+
+    try {
+        const url = `${nas_host}/cgi-bin/filemanager/utilRequest.cgi?func=stat&sid=${nas_sid}&path=${path}&file_total=1&file_name=${filename}`;
+        const response = await fetchWithTimeout(url);
+        const text = await response.text();
+
+        return {
+            content: [{ type: "text", text: text }],
+            isError: false,
+        };
+    } catch (error: any) {
+        return {
+            content: [{ type: "text", text: `Error getting file info: ${error.message}` }],
+            isError: true
+        };
+    }
+}

package/tools/report.ts

@@ -0,0 +1,46 @@
+import { CallToolRequest } from "@modelcontextprotocol/sdk/types.js";
+import { getNasHost, getNasSid, fetchWithTimeout } from "./connect.js";
+
+export async function reportHandler(request: CallToolRequest) {
+    const nas_host = getNasHost();
+    const nas_sid = getNasSid();
+
+    if (!nas_host || !nas_sid) {
+        return {
+            content: [{ type: "text", text: "Not connected to QNAP NAS. Use qnap-connect first." }],
+            isError: true
+        };
+    }
+
+    try {
+        // Fetch system info to get model details
+        const dc = Date.now();
+        const url = `${nas_host}/cgi-bin/sys/sysRequest.cgi?subfunc=sys_info&sid=${nas_sid}&_dc=${dc}`;
+        const response = await fetchWithTimeout(url);
+        const text = await response.text();
+
+        const modelMatch = text.match(/<displayModelName><!\[CDATA\[([^\]]*)\]\]><\/displayModelName>/);
+        const modelName = modelMatch ? modelMatch[1] : "Unknown QNAP Model";
+
+        // Extract IP from host
+        const hostUrl = new URL(nas_host);
+
+        const report = [
+            `### QNAP Connection Report`,
+            `- **Model Name**: ${modelName}`,
+            `- **IP Address**: ${hostUrl.hostname}`,
+            `- **Connected User**: ${process.env.QNAP_USER || "admin"}`,
+            `- **Access URL**: ${nas_host}`
+        ].join('\n');
+
+        return {
+            content: [{ type: "text", text: report }],
+            isError: false,
+        };
+    } catch (error: any) {
+        return {
+            content: [{ type: "text", text: `Error generating report: ${error.message}` }],
+            isError: true
+        };
+    }
+}

package/tools.ts

@@ -0,0 +1,65 @@
+export const tools = [
+    {
+        name: "qnap-connect",
+        description: "Connect to a QNAP NAS and obtain a session ID.",
+        inputSchema: {
+            type: "object",
+            properties: {
+                host: {
+                    type: "string",
+                    description: "QNAP NAS host (e.g., http://10.1.1.241:8080)"
+                },
+                username: {
+                    type: "string",
+                    description: "Username"
+                },
+                password: {
+                    type: "string",
+                    description: "Password"
+                }
+            },
+            required: ["host", "username", "password"]
+        }
+    },
+    {
+        name: "qnap-report",
+        description: "Generate a QNAP system report including CPU, memory, disks and volume status.",
+        inputSchema: {
+            type: "object",
+            properties: {},
+            required: []
+        }
+    },
+    {
+        name: "qnap-dir",
+        description: "List contents of a directory on the QNAP NAS.",
+        inputSchema: {
+            type: "object",
+            properties: {
+                path: {
+                    type: "string",
+                    description: "Directory path (e.g., /Public)"
+                }
+            },
+            required: ["path"]
+        }
+    },
+    {
+        name: "qnap-file-info",
+        description: "Get detailed information about a file on the QNAP NAS.",
+        inputSchema: {
+            type: "object",
+            properties: {
+                path: {
+                    type: "string",
+                    description: "Directory path where the file is located"
+                },
+                filename: {
+                    type: "string",
+                    description: "Name of the file"
+                }
+            },
+            required: ["path", "filename"]
+        }
+    }
+];

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+    "compilerOptions": {
+        "target": "ESNext",
+        "module": "NodeNext",
+        "moduleResolution": "NodeNext",
+        "outDir": "dist",
+        "strict": true,
+        "lib": [
+            "ESNext"
+        ],
+        "esModuleInterop": true,
+        "skipLibCheck": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "include": [
+        "*.ts"
+    ]
+}