- Home
- MCP servers
- LuckyCola
LuckyCola
- typescript
0
GitHub Stars
typescript
Language
6 months ago
First Indexed
3 months ago
Catalog Refreshed
Documentation & install
Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.
Installation
Add the following to your MCP client configuration file.
Configuration
View docs{
"mcpServers": {
"mingle98-luckycola-mcp": {
"command": "npx",
"args": [
"-y",
"luckycola-mcp"
],
"env": {
"MCP_FILE_PATH": "/path/to/your/directory",
"LUCKYCOLA_OPEN_KEY": "YOUR_APP_KEY",
"LUCKYCOLA_OPEN_UID": "YOUR_UID"
}
}
}
}You can deploy and use the LuckyCola MCP Server to access standardized MCP endpoints for image checks, menu queries, and extensive file and image operations. It provides secure environment-based configuration, a suite of tools, and convenient integration with MCP clients for remote or local execution.
How to use
You will connect to this MCP server from an MCP client (such as Claude Desktop or Cursor) and call its available tools to perform tasks like verifying image safety, fetching recipes, or manipulating files. Use the provided environment variables to configure access and base directory paths. Start the server locally or run it via a remote MCP runner, then point your client to the corresponding command or URL.
How to install
Prerequisites: Node.js v21.0.0 or newer and a working internet connection. Ensure you have access to LuckyCola API keys and UID before starting.
# Install dependencies
cd luckycola-mcp
yarn install
# Build the project
yarn build
Configuration and usage notes
Set the following environment variables to enable API access and file operations. These values come from your LuckyCola account:
export LUCKYCOLA_OPEN_KEY="your_app_key"
export LUCKYCOLA_OPEN_UID="your_uid"
export MCP_FILE_PATH="/path/to/your/directory"
Run directly or configure as an MCP server
You can run the server directly for testing, or configure it as an MCP server in your MCP client configuration.
# Run directly
node build/index.js
Server configurations (stdio)
If you want to run the LuckyCola MCP Server via an MCP client using the stdio approach, you have two explicit options shown below. Use the first for a quick npx run, or the second for a local node run once you have built the project.
Config: run with npx
{
"mcpServers": {
"luckycola_mcp": {
"command": "npx",
"args": ["-y", "luckycola-mcp"],
"env": {
"LUCKYCOLA_OPEN_KEY": "your_app_key",
"LUCKYCOLA_OPEN_UID": "your_uid",
"MCP_FILE_PATH": "/path/to/your/directory"
}
}
}
}
Config: run locally with Node
{
"mcpServers": {
"luckycola_mcp": {
"command": "node",
"args": ["/path/to/luckycola-mcp/build/index.js"],
"env": {
"LUCKYCOLA_OPEN_KEY": "your_app_key",
"LUCKYCOLA_OPEN_UID": "your_uid",
"MCP_FILE_PATH": "/path/to/your/directory"
}
}
}
}
API endpoints and tools
The server provides several endpoints to perform common tasks. You can use these tools from your MCP client to perform the requested actions.
Available tools
-
checkImage: Check whether an online image complies with safety rules.
-
getFoodMenu: Retrieve a recipe with steps, ingredients, and duration.
-
fileOperation: Perform file and directory operations inside the configured MCP_FILE_PATH, including read, write, delete, rename, listing, and format conversions.
-
compressImage: Compress image files to reduce size.
-
ocrToImageBase64: Extract text from images and return as base64-encoded text.
Usage examples
In your MCP client, you can call tools like this to perform tasks:
// Check image safety
await callTool("checkImage", { imgUrl: "https://example.com/image.jpg" });
// Get a recipe
await callTool("getFoodMenu", { foodTitle: "番茄炒蛋" });
Available tools
checkImage
Validate an online image against content safety rules and return a safety status.
getFoodMenu
Fetch a recipe including intro, image, steps, ingredients, duration, and notes.
fileOperation
Perform file system tasks such as read, write, delete, rename, list, and format conversions within the specified MCP_FILE_PATH.
compressImage
Compress image files to reduce size while preserving quality.
ocrToImageBase64
Extract text from image files and return as base64-encoded text.