使用说明

项目简介

这是一个基于 Model Context Protocol (MCP) 的天气信息服务器启动器模板。它使用 TypeScript 构建，旨在帮助开发者快速搭建 MCP 服务器，向 LLM 客户端提供天气相关的工具和服务。

主要功能点

• 提供天气工具： 包含示例天气工具，如获取美国特定州的天气预警 (get_alert)。
• 易于扩展： 项目结构清晰，方便开发者添加新的天气或其他领域的工具。
• 开发效率高： 使用 Bun 运行时，提供快速的测试和开发体验。
• 代码质量保证： 集成 Biome 代码格式化和 Lint 工具，保证代码风格一致性和质量。
• 自动化工具创建： 提供脚本快速创建新的 MCP 工具，简化开发流程。

安装步骤

1. 克隆仓库:

   git clone https://github.com/GreatAuk/mcp-weather
   

2. 进入项目目录:

   cd mcp-weather
   

3. 安装依赖:

   bun install
   

服务器配置

要将此 MCP 服务器添加到 MCP 客户端（例如 Claude Desktop），您需要配置客户端以指定服务器的启动命令。以下是您需要添加到客户端配置中的 JSON 代码示例：

{
  "mcpServers": {
    "weather-server": {  //  服务器名称，您可以自定义
      "command": "bun",   //  运行服务器的命令，这里使用 bun
      "args": ["dist/main.js"] //  命令参数，指向编译后的服务器入口文件
    }
  }
}

基本使用方法

1. 构建项目: 在项目根目录下运行以下命令编译 TypeScript 代码：

   bun run build
   

2. 启动服务器: 此服务器设计为由 MCP 客户端启动和管理。您需要在 MCP 客户端的设置中配置好服务器信息后，客户端会在需要时自动启动服务器。
3. 在 LLM 客户端中使用: 在兼容 MCP 协议的 LLM 客户端中，您就可以使用此服务器提供的工具了。例如，在与 LLM 对话时，您可以指示 LLM 使用 'get_alert' 工具查询特定州的天气预警信息。