@samik081/mcp-pve 0.1.0

package/dist/tools/tasks.js

@@ -0,0 +1,106 @@
+/**
+ * Task tools: list, status, log, and management of PVE background tasks.
+ */
+import { z } from "zod";
+import { registerTool } from "../core/tools.js";
+export function registerTaskTools(server, client, config) {
+    // --- Read-only tools ---
+    registerTool(server, config, {
+        name: "pve_list_tasks",
+        description: "List recent tasks on a node with optional filters for status, source, and VMID",
+        category: "tasks",
+        accessTier: "read-only",
+        inputSchema: {
+            node: z.string().describe("The node name"),
+            start: z
+                .number()
+                .optional()
+                .describe("Start index (default: 0)"),
+            limit: z
+                .number()
+                .optional()
+                .describe("Max number of tasks to return (default: 50)"),
+            vmid: z
+                .number()
+                .optional()
+                .describe("Filter by VMID"),
+            typefilter: z
+                .string()
+                .optional()
+                .describe("Filter by task type (e.g. qmstart, vzdump)"),
+        },
+        handler: async (args) => {
+            const params = new URLSearchParams();
+            if (args.start !== undefined)
+                params.set("start", String(args.start));
+            if (args.limit !== undefined)
+                params.set("limit", String(args.limit));
+            if (args.vmid !== undefined)
+                params.set("vmid", String(args.vmid));
+            if (args.typefilter !== undefined)
+                params.set("typefilter", String(args.typefilter));
+            const qs = params.toString();
+            const path = `/nodes/${args.node}/tasks${qs ? `?${qs}` : ""}`;
+            const data = await client.get(path);
+            return JSON.stringify(data, null, 2);
+        },
+    });
+    registerTool(server, config, {
+        name: "pve_get_task_status",
+        description: "Get the status of a specific task by its UPID",
+        category: "tasks",
+        accessTier: "read-only",
+        inputSchema: {
+            node: z.string().describe("The node name"),
+            upid: z.string().describe("The task UPID"),
+        },
+        handler: async (args) => {
+            const data = await client.get(`/nodes/${args.node}/tasks/${encodeURIComponent(String(args.upid))}/status`);
+            return JSON.stringify(data, null, 2);
+        },
+    });
+    registerTool(server, config, {
+        name: "pve_get_task_log",
+        description: "Get the log output of a specific task by its UPID",
+        category: "tasks",
+        accessTier: "read-only",
+        inputSchema: {
+            node: z.string().describe("The node name"),
+            upid: z.string().describe("The task UPID"),
+            start: z
+                .number()
+                .optional()
+                .describe("Start line number (default: 0)"),
+            limit: z
+                .number()
+                .optional()
+                .describe("Max number of log lines to return (default: 50)"),
+        },
+        handler: async (args) => {
+            const params = new URLSearchParams();
+            if (args.start !== undefined)
+                params.set("start", String(args.start));
+            if (args.limit !== undefined)
+                params.set("limit", String(args.limit));
+            const qs = params.toString();
+            const path = `/nodes/${args.node}/tasks/${encodeURIComponent(String(args.upid))}/log${qs ? `?${qs}` : ""}`;
+            const data = await client.get(path);
+            return JSON.stringify(data, null, 2);
+        },
+    });
+    // --- Read-execute tools ---
+    registerTool(server, config, {
+        name: "pve_stop_task",
+        description: "Stop a running task by its UPID",
+        category: "tasks",
+        accessTier: "read-execute",
+        inputSchema: {
+            node: z.string().describe("The node name"),
+            upid: z.string().describe("The task UPID to stop"),
+        },
+        handler: async (args) => {
+            await client.delete(`/nodes/${args.node}/tasks/${encodeURIComponent(String(args.upid))}`);
+            return `Task ${args.upid} stop requested on node ${args.node}.`;
+        },
+    });
+}

package/dist/types/index.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Shared types for the Proxmox VE MCP server.
+ */
+/**
+ * Access tier controlling which tools are registered at startup.
+ *
+ * - "read-only": Only read tools (51 tools)
+ * - "read-execute": Read + execute tools (68 tools)
+ * - "full": All tools including write/delete (105 tools)
+ */
+export type AccessTier = "read-only" | "read-execute" | "full";
+/**
+ * Tool categories corresponding to PVE API namespaces.
+ */
+export type ToolCategory = "nodes" | "qemu" | "lxc" | "storage" | "cluster" | "access" | "pools" | "network" | "firewall" | "backup" | "tasks" | "ha";
+export declare const VALID_CATEGORIES: ToolCategory[];
+export interface AppConfig {
+    baseUrl: string;
+    tokenId: string;
+    tokenSecret: string;
+    accessTier: AccessTier;
+    categories: string[] | null;
+    verifySsl: boolean;
+    debug: boolean;
+}

package/dist/types/index.js

@@ -0,0 +1,17 @@
+/**
+ * Shared types for the Proxmox VE MCP server.
+ */
+export const VALID_CATEGORIES = [
+    "nodes",
+    "qemu",
+    "lxc",
+    "storage",
+    "cluster",
+    "access",
+    "pools",
+    "network",
+    "firewall",
+    "backup",
+    "tasks",
+    "ha",
+];

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@samik081/mcp-pve",
+  "version": "0.1.0",
+  "description": "MCP server for Proxmox VE — manage virtual machines, containers, storage, networking, and clusters through AI coding tools",
+  "type": "module",
+  "main": "./dist/index.js",
+  "bin": {
+    "mcp-pve": "./dist/index.js"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "start": "node dist/index.js",
+    "dev": "node --watch --experimental-strip-types src/index.ts",
+    "inspect": "npm run build && npx @modelcontextprotocol/inspector node dist/index.js",
+    "prepublishOnly": "npm run build"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "keywords": [
+    "proxmox",
+    "pve",
+    "mcp",
+    "model-context-protocol",
+    "virtualization",
+    "ai",
+    "llm",
+    "claude"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Samik081/mcp-pve.git"
+  },
+  "homepage": "https://github.com/Samik081/mcp-pve#readme",
+  "bugs": {
+    "url": "https://github.com/Samik081/mcp-pve/issues"
+  },
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.26.0",
+    "zod": "^3.25.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "typescript": "~5.9.3"
+  }
+}