mcp-grocy 1.9.0

package/build/tools/system/index.js

@@ -0,0 +1,230 @@
+import { BaseToolHandler } from '../base.js';
+import { ErrorCode, McpError } from '@modelcontextprotocol/sdk/types.js';
+import apiClient from '../../api/client.js';
+import config from '../../config/environment.js';
+export const systemToolDefinitions = [
+    {
+        name: 'get_locations',
+        description: 'Get all storage locations from your Grocy instance. Use this to find location IDs and names when working with other tools that require locationId parameters.',
+        inputSchema: {
+            type: 'object',
+            properties: {},
+            required: []
+        }
+    },
+    {
+        name: 'get_quantity_units',
+        description: 'Get all quantity units from your Grocy instance.',
+        inputSchema: {
+            type: 'object',
+            properties: {},
+            required: []
+        }
+    },
+    {
+        name: 'get_users',
+        description: 'Get all users from your Grocy instance.',
+        inputSchema: {
+            type: 'object',
+            properties: {},
+            required: []
+        }
+    },
+    {
+        name: 'get_chores',
+        description: 'Get all chores from your Grocy instance.',
+        inputSchema: {
+            type: 'object',
+            properties: {},
+            required: []
+        }
+    },
+    {
+        name: 'get_tasks',
+        description: 'Get all tasks from your Grocy instance.',
+        inputSchema: {
+            type: 'object',
+            properties: {},
+            required: []
+        }
+    },
+    {
+        name: 'get_batteries',
+        description: 'Get all batteries from your Grocy instance.',
+        inputSchema: {
+            type: 'object',
+            properties: {},
+            required: []
+        }
+    },
+    {
+        name: 'get_equipment',
+        description: 'Get all equipment from your Grocy instance.',
+        inputSchema: {
+            type: 'object',
+            properties: {},
+            required: []
+        }
+    },
+    {
+        name: 'call_grocy_api',
+        description: 'Call a specific Grocy API endpoint with custom parameters.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                endpoint: {
+                    type: 'string',
+                    description: 'Grocy API endpoint to call (e.g., "objects/products"). Do not include /api/ prefix.'
+                },
+                method: {
+                    type: 'string',
+                    enum: ['GET', 'POST', 'PUT', 'DELETE'],
+                    description: 'HTTP method to use',
+                    default: 'GET'
+                },
+                body: {
+                    type: 'object',
+                    description: 'Optional request body for POST/PUT requests'
+                }
+            },
+            required: ['endpoint']
+        }
+    },
+    {
+        name: 'test_request',
+        description: `Test a REST API endpoint and get detailed response information. Base URL: ${config.getGrocyBaseUrl()} | SSL Verification ${config.get().GROCY_ENABLE_SSL_VERIFY ? 'enabled' : 'disabled'} (see config resource for SSL settings) | Authentication: ${config.hasApiKeyAuth() ? 'API Key using header: GROCY-API-KEY' : 'No authentication configured'}`,
+        inputSchema: {
+            type: 'object',
+            properties: {
+                method: {
+                    type: 'string',
+                    enum: ['GET', 'POST', 'PUT', 'DELETE'],
+                    description: 'HTTP method to use'
+                },
+                endpoint: {
+                    type: 'string',
+                    description: 'Endpoint path (e.g. "/users"). Do not include full URLs - only the path.'
+                },
+                body: {
+                    type: 'object',
+                    description: 'Optional request body for POST/PUT requests'
+                },
+                headers: {
+                    type: 'object',
+                    description: 'Optional request headers for one-time use.',
+                    additionalProperties: {
+                        type: 'string'
+                    }
+                }
+            },
+            required: ['method', 'endpoint']
+        }
+    }
+];
+class SystemToolHandlers extends BaseToolHandler {
+    getLocations = async (args) => {
+        return this.handleApiCall('/objects/locations', 'Get all storage locations');
+    };
+    getQuantityUnits = async (args) => {
+        return this.handleApiCall('/objects/quantity_units', 'Get all quantity units');
+    };
+    getUsers = async (args) => {
+        return this.handleApiCall('/users', 'Get all users');
+    };
+    getChores = async (args) => {
+        return this.handleApiCall('/objects/chores', 'Get all chores');
+    };
+    getTasks = async (args) => {
+        return this.handleApiCall('/objects/tasks', 'Get all tasks');
+    };
+    getBatteries = async (args) => {
+        return this.handleApiCall('/objects/batteries', 'Get all batteries');
+    };
+    getEquipment = async (args) => {
+        return this.handleApiCall('/objects/equipment', 'Get all equipment');
+    };
+    callGrocyApi = async (args) => {
+        const { endpoint, method = 'GET', body = null } = args;
+        if (!endpoint) {
+            throw new McpError(ErrorCode.InvalidParams, 'Missing required parameter: endpoint');
+        }
+        // Remove leading /api/ if present
+        const cleanEndpoint = endpoint.replace(/^\/?(?:api\/)?/, '');
+        try {
+            const response = await apiClient.request(`/${cleanEndpoint}`, {
+                method,
+                body
+            });
+            return this.createSuccessResult(response.data);
+        }
+        catch (error) {
+            console.error(`Error calling Grocy API endpoint ${endpoint}:`, error);
+            return this.createErrorResult(`Failed to call Grocy API endpoint ${endpoint}: ${error.message}`);
+        }
+    };
+    testRequest = async (args) => {
+        // This is a more complex handler that provides detailed request/response information
+        // Implementation would be similar to the original handleTestRequest but simplified
+        const { method, endpoint, body, headers = {} } = args;
+        if (!method || !endpoint) {
+            throw new McpError(ErrorCode.InvalidParams, 'method and endpoint are required');
+        }
+        const normalizedEndpoint = `/${endpoint.replace(/^\/+|\/+$/g, '')}`;
+        try {
+            const startTime = Date.now();
+            const response = await apiClient.request(normalizedEndpoint, {
+                method,
+                body,
+                headers
+            });
+            const endTime = Date.now();
+            const responseObj = {
+                request: {
+                    url: `${config.getGrocyBaseUrl()}${normalizedEndpoint}`,
+                    method,
+                    headers: { ...config.getCustomHeaders(), ...headers },
+                    body,
+                    authMethod: config.hasApiKeyAuth() ? 'apikey' : 'none'
+                },
+                response: {
+                    statusCode: response.status,
+                    timing: `${endTime - startTime}ms`,
+                    headers: response.headers,
+                    body: response.data
+                },
+                validation: {
+                    isError: response.status >= 400,
+                    messages: response.status >= 400 ?
+                        [`Request failed with status ${response.status}`] :
+                        ['Request completed successfully']
+                }
+            };
+            return this.createSuccessResult(responseObj);
+        }
+        catch (error) {
+            return this.createErrorResult(`Test request failed: ${error.message}`, {
+                request: {
+                    url: `${config.getGrocyBaseUrl()}${normalizedEndpoint}`,
+                    method,
+                    headers: { ...config.getCustomHeaders(), ...headers },
+                    body
+                }
+            });
+        }
+    };
+}
+const systemHandlers = new SystemToolHandlers();
+export const systemModule = {
+    definitions: systemToolDefinitions,
+    handlers: {
+        get_locations: systemHandlers.getLocations,
+        get_quantity_units: systemHandlers.getQuantityUnits,
+        get_users: systemHandlers.getUsers,
+        get_chores: systemHandlers.getChores,
+        get_tasks: systemHandlers.getTasks,
+        get_batteries: systemHandlers.getBatteries,
+        get_equipment: systemHandlers.getEquipment,
+        call_grocy_api: systemHandlers.callGrocyApi,
+        test_request: systemHandlers.testRequest
+    }
+};

package/build/tools/types.js

@@ -0,0 +1 @@
+export {};

package/build/version.js

@@ -0,0 +1,4 @@
+// Auto-generated file - DO NOT MODIFY
+export const VERSION = '1.9.0';
+export const PACKAGE_NAME = 'mcp-grocy';
+export const SERVER_NAME = 'grocy-api';

package/package.json

@@ -0,0 +1,87 @@
+{
+  "name": "mcp-grocy",
+  "version": "1.9.0",
+  "description": "Model Context Protocol (MCP) server for Grocy integration",
+  "license": "MIT",
+  "type": "module",
+  "publishConfig": {
+    "name": "mcp-grocy",
+    "access": "public"
+  },
+  "bin": {
+    "mcp-grocy": "./build/main.js"
+  },
+  "files": [
+    "build",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "prebuild": "node scripts/build.js",
+    "build": "tsc",
+    "prepare": "npm run build",
+    "watch": "tsc --watch",
+    "inspector": "npx @modelcontextprotocol/inspector build/main.js",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "check-tools": "node scripts/check-tools.js",
+    "validate-release": "node scripts/check-tools.js --validate-release",
+    "update-api-docs": "node scripts/fetch-grocy-api.js",
+    "verify-release-config": "node scripts/verify-release-config.js",
+    "prepare-dev-release": "node scripts/prepare-dev-release.js",
+    "prepare-dev-release:patch": "node scripts/prepare-dev-release.js --patch",
+    "prepare-dev-release:minor": "node scripts/prepare-dev-release.js --minor",
+    "prepare-dev-release:major": "node scripts/prepare-dev-release.js --major",
+    "prepare-dev-release:dryrun": "node scripts/prepare-dev-release.js --dry-run"
+  },
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.11.4",
+    "axios": "^1.6.7",
+    "cors": "^2.8.5",
+    "dotenv": "^16.5.0",
+    "express": "^5.1.0",
+    "fuse.js": "^7.0.0",
+    "uuid": "^11.1.0",
+    "zod": "^3.22.0"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^19.6.1",
+    "@commitlint/config-conventional": "^19.6.0",
+    "@commitlint/types": "^19.6.1",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/exec": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "@types/cors": "^2.8.18",
+    "@types/express": "^5.0.2",
+    "@types/node": "^20.11.20",
+    "@types/uuid": "^10.0.0",
+    "fs-extra": "^11.2.0",
+    "semantic-release": "^22.0.12",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.3.3",
+    "vitest": "^3.1.3"
+  },
+  "keywords": [
+    "grocy",
+    "mcp",
+    "rest",
+    "api",
+    "http",
+    "testing",
+    "cline",
+    "development",
+    "typescript"
+  ],
+  "author": "miguelangel-nubla",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/miguelangel-nubla/mcp-grocy.git"
+  },
+  "bugs": {
+    "url": "https://github.com/miguelangel-nubla/mcp-grocy/issues"
+  },
+  "homepage": "https://github.com/miguelangel-nubla/mcp-grocy#readme",
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}