Files
higress/plugins/wasm-go/mcp-servers/mcp-recipe-query/README_ZH.md
2025-04-16 14:48:53 +08:00

54 lines
3.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 菜谱查询
API认证需要的APP Code请在阿里云API市场申请: https://market.aliyun.com/apimarket/detail/cmapi00045093
## 什么是云市场API MCP服务
阿里云云市场是生态伙伴的交易服务平台我们致力于为合作伙伴提供覆盖上云、商业化和售卖的全链路服务帮助客户高效获取、部署和管理优质生态产品。云市场的API服务涵盖以下几个类目应用开发、身份验证与金融、车辆交通与物流、企业服务、短信与运营商、AI应用与OCR、生活服务。
云市场API依托Higress提供MCP服务您只需在云市场完成订阅并获取AppCode通过Higress MCP Server进行配置即可无缝集成云市场API服务。
## 如何在使用云市场API MCP服务
1. 进入API详情页订阅该API。您可以优先使用免费试用。
2. 前往云市场用户控制台使用阿里云账号登陆后查看已订阅API服务的AppCode并配置到Higress MCP Server的配置中。注意在阿里云市场订阅API服务后您将获得AppCode。对于您订阅的所有API服务此AppCode是相同的您只需使用这一个AppCode即可访问所有已订阅的API服务。
3. 云市场用户控制台会实时展示已订阅的预付费API服务的可用额度如您免费试用额度已用完您可以选择重新订阅。
# MCP服务器功能简介
本文档介绍了MCP服务器的主要功能及其用途以及每个工具的具体使用场景。
## 功能简介
该MCP服务器主要用于提供菜谱相关的API服务。通过这些API用户可以进行多种类型的查询包括按分类检索菜谱、根据ID获取详细信息、查看菜谱分类列表及通过关键词搜索菜谱等。此外所有请求均需携带特定的认证信息以确保安全访问。
## 工具简介
### 按分类检索
- **描述**:此工具支持从万种菜谱中查找符合条件的结果,支持按照不同的分类或关键词进行检索。每条记录包含了主料、辅料和详细的制作流程。
- **参数**
- `classid` (必填):指定的分类标识符。
- `num` (必填):希望返回的结果数目。
- `start` (可选)结果集中的起始位置默认为0。
- **应用场景**:当需要快速找到某一类别的多个食谱时非常有用。
### 根据ID查询详情
- **描述**允许用户基于提供的菜谱ID来获取更加详尽的信息。
- **参数**
- `id` (必填):目标菜谱的唯一标识符。
- **应用场景**适用于已经知道某道菜品的确切ID并想要了解其全部细节的情况。
### 菜谱分类
- **描述**:列出所有的菜谱类别,帮助开发者理解数据结构并据此构建更丰富的应用程序界面。
- **参数**:无
- **应用场景**:对于需要展示所有可用分类或者让用户选择感兴趣的分类的应用来说至关重要。
### 菜谱搜索
- **描述**:允许使用关键词对整个数据库执行全文搜索操作。
- **参数**
- `keyword` (必填):用于匹配的搜索词。
- `num` (必填):期望返回的搜索结果数量。
- `start` (可选)搜索结果中的开始位置默认值为0。
- **应用场景**:适合于那些希望通过简单输入就能找到相关食谱的应用程序。
以上就是关于MCP服务器提供的各项功能和服务的简要说明。通过合理利用这些工具开发者能够轻松地开发出满足不同需求的美食应用。