使用说明
项目简介
本项目 'mcp-server-quickstart' 是一个基于 Model Context Protocol (MCP) 的服务器实现,专注于提供天气信息服务。它通过调用美国国家气象局 (NWS) 的 API,向 MCP 客户端提供天气警报和天气预报数据。该服务器实现了 MCP 协议,可以与任何兼容 MCP 协议的客户端进行通信,为 LLM 应用提供实时的天气上下文信息。
主要功能点
- 获取天气警报 (get-alerts): 根据美国州份代码,获取该州当前生效的天气警报信息。例如,可以查询加利福尼亚州 (CA) 的天气警报。
- 获取天气预报 (get-forecast): 根据经纬度坐标,获取指定位置的天气预报信息。例如,可以查询某个具体地点的详细天气预报,包括温度、风速、天气状况等。
安装步骤
- 安装 Node.js 和 npm: 确保你的电脑上已经安装了 Node.js 和 npm (Node 包管理器)。你可以从 nodejs.org 下载并安装。
- 下载仓库代码: 从 GitHub 仓库 https://github.com/zaki-yama-labs/mcp-server-quickstart 下载代码到本地。
- 进入项目目录: 打开终端或命令提示符,进入下载的代码目录。
- 安装依赖: 在项目根目录下运行命令 'npm install',安装项目所需的依赖包。
服务器配置
要使 MCP 客户端连接到此服务器,你需要配置客户端的服务器信息。以下是一个示例 JSON 配置,你需要将其添加到你的 MCP 客户端配置中。
{ "servers": [ { "name": "weather", "command": "node", "args": ["src/index.ts"], "transport": "stdio" } ] }
配置参数说明:
- 'name': 服务器名称,这里设置为 "weather",与代码中 'McpServer' 实例化的名称一致。
- 'command': 启动服务器的命令,这里使用 'node',假设你使用 Node.js 直接运行 TypeScript 代码。如果你的环境需要先编译,请根据实际情况调整命令。
- 'args': 命令的参数,这里指定了服务器入口文件 'src/index.ts' 的路径。
- 'transport': 传输协议,这里使用 'stdio',表示通过标准输入输出流进行通信。
注意: 请确保你的 MCP 客户端能够找到 'node' 命令,并且有执行 'src/index.ts' 文件的权限。根据你的实际环境,可能需要调整 'command' 和 'args' 配置。
基本使用方法
- 启动服务器: 在终端中,进入项目目录,并确保已经安装依赖。然后,运行命令 'node src/index.ts' 启动 MCP 服务器。你会在终端看到 'Weather MCP Server running on stdio' 的提示信息,表示服务器已成功启动。
- 配置 MCP 客户端: 根据你的 MCP 客户端的使用说明,将上面提供的服务器配置信息添加到客户端的配置文件中。
- 使用客户端调用工具: 使用 MCP 客户端连接到 "weather" 服务器后,你就可以调用以下工具来获取天气信息:
- 'get-alerts': 调用此工具并传入 'state' 参数(例如 '"CA"')来获取指定州的天气警报。
- 'get-forecast': 调用此工具并传入 'latitude' 和 'longitude' 参数(例如 'latitude: 34.0522, longitude: -118.2437')来获取指定地点的天气预报。
具体如何调用工具以及查看返回结果,请参考你使用的 MCP 客户端的文档。客户端通常会提供图形界面或命令行界面来与 MCP 服务器交互。
信息
分类
网页与API