mirror of
https://github.com/worryzyy/HowToCook-mcp.git
synced 2026-06-04 21:05:55 +08:00
docs: update README.md
This commit is contained in:
parent
3197d61624
commit
0fd708d41e
29
README.md
29
README.md
@ -27,8 +27,9 @@
|
||||
|
||||
1. **📚 查询全部菜谱** - 获取所有可用菜谱数据,做菜百科全书 -- 慎用这个--上下文太大
|
||||
2. **🔍 根据分类查询菜谱** - 按照分类筛选菜谱,想吃水产?早餐?荤菜?主食?一键搞定!
|
||||
3. **🧩 智能推荐膳食** - 根据你的忌口、过敏原和用餐人数,为你规划整整一周的美味佳肴
|
||||
4. **🎲 不知道吃什么** - 选择困难症福音!根据人数直接推荐今日菜单,再也不用纠结了
|
||||
3. **📖 查询指定菜谱** - 根据菜谱名称查询特定菜谱的完整详情,包括食材、步骤等
|
||||
4. **🧩 智能推荐膳食** - 根据你的忌口、过敏原和用餐人数,为你规划整整一周的美味佳肴
|
||||
5. **🎲 不知道吃什么** - 选择困难症福音!根据人数直接推荐今日菜单,再也不用纠结了
|
||||
|
||||
## 🚀 快速上手
|
||||
|
||||
@ -76,12 +77,12 @@ npm start
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"howtocook-mcp": {
|
||||
"command": "npx",
|
||||
"args": ["-y", "howtocook-mcp"]
|
||||
}
|
||||
}
|
||||
"mcpServers": {
|
||||
"howtocook-mcp": {
|
||||
"command": "npx",
|
||||
"args": ["-y", "howtocook-mcp"]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@ -89,12 +90,12 @@ npm start
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"howtocook-mcp": {
|
||||
"command": "node",
|
||||
"args": ["youpath\\howtocook-mcp\\build\\index.js"]
|
||||
}
|
||||
}
|
||||
"mcpServers": {
|
||||
"howtocook-mcp": {
|
||||
"command": "node",
|
||||
"args": ["youpath\\howtocook-mcp\\build\\index.js"]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
35
README_EN.md
35
README_EN.md
@ -29,6 +29,7 @@ This MCP server provides the following culinary tools:
|
||||
2. **🔍 Query Recipes by Category** - Filter recipes by category: seafood, breakfast, meat dishes, staple foods, and more!
|
||||
3. **🧩 Smart Meal Planning** - Get a full week's meal plan based on dietary restrictions, allergies, and number of diners
|
||||
4. **🎲 Don't Know What to Eat?** - Perfect for the indecisive! Get instant menu recommendations based on party size
|
||||
5. **🔎 Query Specific Recipe** - Search for specific recipes by name or ID, supports both exact and fuzzy matching to save tokens
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
@ -76,12 +77,12 @@ Then add the MCP server configuration in Cursor settings:
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"howtocook-mcp": {
|
||||
"command": "npx",
|
||||
"args": ["-y", "howtocook-mcp"]
|
||||
}
|
||||
}
|
||||
"mcpServers": {
|
||||
"howtocook-mcp": {
|
||||
"command": "npx",
|
||||
"args": ["-y", "howtocook-mcp"]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@ -89,12 +90,12 @@ Then add the MCP server configuration in Cursor settings:
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"howtocook-mcp": {
|
||||
"command": "node",
|
||||
"args": ["yourpath\\howtocook-mcp\\build\\index.js"]
|
||||
}
|
||||
}
|
||||
"mcpServers": {
|
||||
"howtocook-mcp": {
|
||||
"command": "node",
|
||||
"args": ["yourpath\\howtocook-mcp\\build\\index.js"]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@ -151,6 +152,16 @@ Parameters:
|
||||
|
||||
- `peopleCount`: Number of diners (1-10)
|
||||
|
||||
### 5. 🔎 Query Specific Recipe
|
||||
|
||||
```
|
||||
Please use the howtocook MCP service to query the recipe for "Kung Pao Chicken"
|
||||
```
|
||||
|
||||
Parameters:
|
||||
|
||||
- `recipeId`: Recipe name or ID to search for
|
||||
|
||||
## 📝 Tips
|
||||
|
||||
- This package is published on npm and can be installed globally via `npm install -g howtocook-mcp`
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "howtocook-mcp",
|
||||
"version": "0.0.7",
|
||||
"version": "0.0.9",
|
||||
"type": "module",
|
||||
"main": "build/index.js",
|
||||
"bin": {
|
||||
|
||||
Loading…
Reference in New Issue
Block a user