使用说明

项目简介

AQICN MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,它利用世界空气质量指数 (AQICN) 项目的数据,为大型语言模型 (LLM) 应用提供实时的空气质量信息。通过此服务器,LLM 可以获取指定城市或地理位置的空气质量数据,并搜索相关的空气监测站信息,从而增强 LLM 在环境信息查询和应用方面的能力。

主要功能点

  • 城市空气质量查询 (city_aqi): 根据城市名称查询该城市最新的空气质量指数 (AQI) 以及主要污染物等详细信息。
  • 地理位置空气质量查询 (geo_aqi): 根据经纬度坐标查询特定地理位置的空气质量数据。
  • 空气监测站搜索 (search_station): 根据关键词搜索相关的空气质量监测站,例如按城市名或站点名搜索。

安装步骤

  1. 安装 Python 环境和依赖: 建议使用 'uv' 管理 Python 环境。首先确保已安装 'uv',然后执行以下命令安装项目依赖:

    uv pip install -e .

    这将安装项目所需的所有 Python 包。

  2. 配置 API 密钥:AQICN 官网 获取 API 密钥,并在项目根目录下创建 '.env' 文件,添加以下内容,将 'your_api_key_here' 替换为您的实际 API 密钥:

    AQICN_API_KEY=your_api_key_here

    或者,您也可以直接设置名为 'AQICN_API_KEY' 的环境变量。

服务器配置

要让 MCP 客户端(例如 Claude Desktop)连接到 AQICN MCP Server,您需要提供以下配置信息。这是一个 JSON 格式的配置示例,用于描述如何启动和连接到该服务器:

{
  "server_name": "AQICN MCP Server",
  "command": "mcp",
  "args": ["install", "aqicn_server.py"]
}

配置参数说明:

  • 'server_name': 服务器名称,您可以自定义,用于在 MCP 客户端中标识该服务器。例如 '"AQICN MCP Server"'。
  • 'command': 运行 MCP 服务器的命令,通常为 'mcp'。
  • 'args': 传递给 'mcp' 命令的参数。'["install", "aqicn_server.py"]' 表示使用 'mcp install' 命令安装并运行 'aqicn_server.py' 文件,从而启动 AQICN MCP Server。

请注意: MCP 客户端会读取这些配置信息,并自动执行 'command' 和 'args' 来启动服务器,并建立连接。用户无需手动执行服务器启动命令。

基本使用方法

AQICN MCP Server 启动后,您可以使用 MCP 客户端(如 Claude Desktop 或其他 MCP 兼容的客户端)来调用服务器提供的工具。客户端会通过 JSON-RPC 协议与服务器通信。

例如,在 MCP 客户端中,您可以调用 'city_aqi' 工具查询北京的空气质量:

from mcp import Client

async with Client() as client:
    beijing_data = await client.city_aqi(city="beijing")
    print(f"北京 AQI: {beijing_data.aqi}")

或者使用 'geo_aqi' 工具查询特定经纬度位置的空气质量:

from mcp import Client

async with Client() as client:
    tokyo_data = await client.geo_aqi(latitude=35.6762, longitude=139.6503)
    print(f"东京 AQI: {tokyo_data.aqi}")

更多使用示例和工具详情请参考仓库的 README 文档和代码注释。

信息

分类

网页与API