mcp-grocy-api

saya6k/mcp-grocy-api

3.3

If you are the rightful owner of mcp-grocy-api and would like to certify it and/or have it hosted online, please leave a comment on the right or send an email to henry@mcphub.com.

The MCP Grocy API is a specialized server designed to interface with Grocy's API, providing a streamlined and efficient way to manage household inventory and tasks.

The MCP Grocy API is a tailored solution for users of the Grocy application, which is a self-hosted groceries and household management system. This project is a specialized fork of the mcp-rest-api, refactored to work specifically with Grocy's API. It allows users to interact with their Grocy instance through a model context protocol server, offering a seamless integration for managing inventory, shopping lists, recipes, and more. The server can be deployed using Node.js or Docker, and is also available as a Home Assistant add-on, making it versatile for different deployment environments. With the ability to run in both production and development modes, the MCP Grocy API provides flexibility for developers and end-users alike. The project is open-source and licensed under the MIT License, encouraging community contributions and modifications.

Features

  • Seamless integration with Grocy's API for efficient household management.
  • Available as a Docker image and Home Assistant add-on for easy deployment.
  • Supports both production and development modes with mock responses.
  • Environment variable configuration for flexible setup.
  • Open-source with community support and contributions.

Usages

npm installation

git clone -b main https://github.com/saya6k/mcp-grocy-api.git
cd mcp-grocy-api
npm install
npm run build

docker usage

docker run -e GROCY_APIKEY_VALUE=your_api_key -e GROCY_BASE_URL=http://your-grocy-instance ghcr.io/saya6k/mcp-grocy-api:latest

home assistant addon

[![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fsaya6k%2Fhassio-addons)

npx usage

npx cross-env GROCY_BASE_URL=http://your-grocy-instance GROCY_APIKEY_VALUE=your_api_key mcp-grocy-api

npx development mode

npx cross-env GROCY_BASE_URL=http://your-grocy-instance GROCY_APIKEY_VALUE=your_api_key mcp-grocy-api --mock