Mcp Grocy Api
What is Mcp Grocy Api
mcp-grocy-api is a Model Context Protocol (MCP) server that integrates seamlessly with the Grocy API, enabling AI assistants to manage household tasks such as inventory management, shopping lists, meal planning, and chores.
Use cases
Use cases include automating grocery shopping, tracking household inventory, planning meals based on available ingredients, and managing household chores efficiently.
How to use
To use mcp-grocy-api, clone the repository, install dependencies using npm, and run the server with your Grocy API URL and API key. Alternatively, you can run it in Docker or as a Home Assistant add-on.
Key features
Key features include complete integration with Grocy’s API, support for managing household inventory, shopping lists, meal planning, and chores, as well as the ability to run in development mode with mock responses.
Where to use
mcp-grocy-api can be used in home automation systems, personal assistant applications, and any environment where household management is required.
Clients Supporting MCP
The following are the main client software that supports the Model Context Protocol. Click the link to visit the official website for more information.
Overview
What is Mcp Grocy Api
mcp-grocy-api is a Model Context Protocol (MCP) server that integrates seamlessly with the Grocy API, enabling AI assistants to manage household tasks such as inventory management, shopping lists, meal planning, and chores.
Use cases
Use cases include automating grocery shopping, tracking household inventory, planning meals based on available ingredients, and managing household chores efficiently.
How to use
To use mcp-grocy-api, clone the repository, install dependencies using npm, and run the server with your Grocy API URL and API key. Alternatively, you can run it in Docker or as a Home Assistant add-on.
Key features
Key features include complete integration with Grocy’s API, support for managing household inventory, shopping lists, meal planning, and chores, as well as the ability to run in development mode with mock responses.
Where to use
mcp-grocy-api can be used in home automation systems, personal assistant applications, and any environment where household management is required.
Clients Supporting MCP
The following are the main client software that supports the Model Context Protocol. Click the link to visit the official website for more information.
Content
MCP Grocy API
This project is a specialized fork of mcp-rest-api, refactored to work specifically with Grocy’s API.
Installation
NPM
git clone -b main https://github.com/saya6k/mcp-grocy-api.git
cd mcp-grocy-api
npm install
npm run build
Docker
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 Add-on
The MCP Grocy API is available as a Home Assistant add-on through saya6k’s add-on repository.
Usage
To use the API, you need to provide the Grocy API URL and API key:
# Start the server with environment variables
npx cross-env GROCY_BASE_URL=http://your-grocy-instance GROCY_APIKEY_VALUE=your_api_key mcp-grocy-api
Or to start in development mode:
# Start the server with sample/mock responses (no real Grocy instance needed)
npx cross-env GROCY_BASE_URL=http://your-grocy-instance GROCY_APIKEY_VALUE=your_api_key mcp-grocy-api --mock
Environment Variables
GROCY_BASE_URL: Your Grocy API URLGROCY_APIKEY_VALUE: Your Grocy API keyGROCY_ENABLE_SSL_VERIFY: Whether to verify SSL certificateREST_RESPONSE_SIZE_LIMIT: REST API response size (default: 10000 = 10KB)
Documentation
API Reference
For the full API reference, see the API Reference.
Configuration
For configuration options, see the Configuration Guide.
Development
Prerequisites
- Node.js 18 or higher
- Grocy instance (or use
--mockfor development)
Testing
npm test
License
This project is licensed under the MIT License.
Dev Tools Supporting MCP
The following are the main code editors that support the Model Context Protocol. Click the link to visit the official website for more information.
