使用说明
项目简介
本项目是一个实现了 Model Context Protocol (MCP) 协议的天气预警服务器。它利用美国国家气象局 (NWS) 的 API 获取天气数据,并通过 MCP 协议向 LLM 客户端提供美国各州的天气预警信息。
主要功能点
- 获取州天气预警: 提供 'get-alerts' 工具,允许 LLM 客户端查询指定美国州份的实时天气预警信息。
- 标准化MCP接口: 遵循 MCP 协议标准,易于集成到支持 MCP 协议的 LLM 应用中。
- 实时数据: 数据来源于美国国家气象局 (NWS) API,保证信息的及时性和准确性。
安装步骤
- 安装 Node.js: 确保您的系统已安装 Node.js 和 npm (Node 包管理器)。
- 获取项目代码: 从 GitHub 下载或克隆项目代码(请注意,您当前查看的是代码片段,完整的仓库可能需要您自行查找和下载)。
- 进入项目目录: 使用命令行工具进入 'mcp-weather' 目录(假设项目结构如此)。
- 安装依赖: 运行 'npm install' 命令安装项目所需的依赖包。
- 构建项目: 运行 'npm run build' 命令构建项目(如果项目包含构建脚本,或者直接使用 'tsc' 命令编译 TypeScript 代码)。
服务器配置
为了让 MCP 客户端连接到此天气预警服务器,您需要在客户端配置中添加以下服务器信息。这是一个 JSON 格式的配置示例,请根据您的实际项目路径进行调整:
{ "serverName": "weather", "command": "node", "args": ["mcp-weather/dist/index.js"] }
配置参数说明:
- 'serverName': 服务器名称,这里设置为 "weather"。
- 'command': 启动服务器的命令,通常为 'node',表示使用 Node.js 运行。
- 'args': 命令参数,指向服务器入口文件。这里假设编译后的入口文件路径是 'mcp-weather/dist/index.js'。如果未进行编译,且直接运行 'src/index.ts',则可能需要修改为 '["mcp-weather/src/index.js"]'。
基本使用方法
- 启动服务器: 在完成安装和配置后,MCP 服务器将在客户端连接时自动启动。您无需手动启动服务器,MCP 客户端会负责管理服务器的生命周期。
- 客户端请求: LLM 客户端可以使用 'get-alerts' 工具查询天气预警。例如,要查询加利福尼亚州(CA)的天气预警,客户端需要构造符合 MCP 协议的 JSON-RPC 请求,调用 'get-alerts' 工具,并传递参数 '{"state": "CA"}'。
- 查看预警信息: 服务器会将查询结果以 MCP 响应的形式返回给客户端,其中包含指定州份的当前天气预警信息。
信息
分类
网页与API