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.
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 .
Configuration
For configuration options, see the .
Development
Prerequisites
- Node.js 18 or higher
- Grocy instance (or use
--mock
for development)
Testing
npm test
License
This project is licensed under the .