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

50 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/cmapi011138
## 什么是云市场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服务器`vehicle-restriction-query`的主要功能及其工具的简要介绍。此服务器专注于提供与城市车辆限行信息相关的查询服务,通过两个主要接口实现:城市限行查询以及获取支持的城市列表。
## 功能简介
`vehicle-restriction-query`服务器主要用于提供基于城市代号及日期来查询特定城市的车辆限行政策信息的服务。此外,它还允许用户获取当前支持的所有城市代码和名称列表。这些功能对于需要了解或遵守地方交通规则的应用程序特别有用,例如地图应用、导航系统等。
## 工具简介
### 城市限行查询接口
- **用途**:根据指定的城市代号和日期检索该城市的车辆限行详情。
- **使用场景**:适用于任何需要实时更新其关于特定地区车辆限制信息的应用程序或服务。
- **参数说明**:
- `city`: 必填项,代表所查询城市的唯一标识符。
- `date`: 必填项,默认为当日;用于指定查询的具体日期。
- **请求方法**: GET
- **响应结构**:
- 包含了诸如限行区域、适用日期、受限车牌号码等一系列详细信息。
- 每个响应字段都有明确的数据类型定义,便于解析处理。
### 获取城市接口
- **用途**:返回一个包含所有可查询城市代号及其对应中文名的列表。
- **使用场景**:当应用程序需要展示给用户一个下拉菜单供选择不同城市时非常有用。
- **参数说明**:
- 此接口无需额外参数输入。
- **请求方法**: GET
- **响应结构**:
- 提供了一个简单的JSON数组格式结果其中每个元素都包含了城市代码 (`city`) 和城市名称 (`cityname`) 的映射关系。
- 这种结构使得客户端能够轻松地将数据转换成适合显示的形式。
以上就是`vehicle-restriction-query`服务器所提供功能和服务的基本概述。希望这份文档能够帮助开发者更好地理解和利用这些API接口。