使用说明

项目简介

本项目是一个实现了 Model Context Protocol (MCP) 协议的服务器,专注于提供 COVID-19 疫情统计数据查询功能。通过集成 disease.sh API,该服务器能够为 MCP 客户端提供指定国家或地区的实时疫情数据。客户端可以通过调用服务器提供的 'getCovidStatsByCountry' 工具,便捷地获取所需的疫情信息,从而在 LLM 应用中集成最新的健康数据。

主要功能点

  • 提供 COVID-19 疫情数据查询工具: 通过 'getCovidStatsByCountry' 工具,用户可以查询指定国家或地区的详细 COVID-19 疫情统计数据。
  • 数据来源可靠: 数据来源于 disease.sh API,保证了数据的准确性和时效性。
  • 标准 MCP 服务器: 遵循 Model Context Protocol 协议,易于与各种 MCP 客户端集成,实现标准化的上下文数据访问。
  • 使用 Stdio 传输协议: 采用 Stdio 作为传输协议,简化部署和运行,方便在本地环境或服务器上运行。

安装步骤

  1. 克隆仓库
    git clone https://github.com/aarushkx/covid-mcp-server.git
    cd covid-mcp-server
  2. 安装依赖 确保已安装 Node.js 和 npm (或 yarn)。在项目根目录下运行:
    npm install
    yarn install
  3. 配置环境变量 在项目根目录下创建 '.env' 文件,并添加以下内容,指定 disease.sh API 的基础 URL:
    COVID_API_URL=https://disease.sh/v3/covid/countries
  4. 构建项目 运行构建命令编译 TypeScript 代码到 JavaScript:
    npm run build
    yarn build

服务器配置

MCP 客户端需要以下配置信息来连接到此服务器。请将以下 JSON 配置添加到您的 MCP 客户端配置中:

{
  "serverName": "covid-report",
  "command": "node",
  "args": ["dist/index.js"]
}
  • 'serverName': 服务器名称,必须与代码中 'McpServer' 实例化的名称一致,此处为 "covid-report"。
  • 'command': 启动服务器的命令,这里使用 'node' 命令来运行 JavaScript 文件。
  • 'args': 传递给 'node' 命令的参数,'dist/index.js' 是编译后的服务器入口文件路径。

基本使用方法

  1. 启动服务器 在项目根目录下,运行以下命令启动 MCP 服务器:
    npm start
    yarn start
    服务器成功启动后,将在控制台输出 'Covid MCP Server is running on stdio'。
  2. 连接 MCP 客户端 使用支持 MCP 协议的客户端(例如 Claude Desktop),根据上述 服务器配置 中的信息配置并连接到该服务器。
  3. 调用工具 在 MCP 客户端中,即可使用 'getCovidStatsByCountry' 工具,并提供国家名称作为参数来查询 COVID-19 疫情数据。服务器将返回包含疫情数据的 JSON 字符串。

信息

分类

网页与API