Weather MCP Server
# Weather MCP Server
A weather MCP (Model Context Protocol) server developed with TypeScript, providing simulated weather data and related functionality.
## Features
- š¤ļø Get current weather information
- š
Multi-day weather forecast
- ā ļø Weather alert system
- š Location search functionality
- š Weather statistics
- š Mock data support
## Install Dependencies
```bash
pnpm install
```
## š Usage
### Installation and Build
```bash
# Install dependencies
pnpm install
# Build project
pnpm run build
```
### Startup Methods
#### 1. MCP Protocol (stdio)
```bash
# For MCP client integration
pnpm start
```
#### 2. HTTP API Server š
```bash
# Start HTTP server (default port 8080)
pnpm run start:http
# Start HTTP server (specified port 3001)
pnpm run start:http:3001
# Or specify port directly
node dist/http-server.js 8080
```
#### 3. Simple HTTP Server (Recommended) š
```bash
# Start with default port 8080
pnpm run start:simple
# Start with specific ports
pnpm run start:simple:3000 # Development port
pnpm run start:simple:5000 # Alternative port
pnpm run start:simple:9000 # High port
# Or use the serve commands
pnpm run serve # Default port 8080
pnpm run serve:dev # Development port 3000
pnpm run serve:prod # Production port 8080
# Or specify any port directly
node dist/simple-http-server.js 4000
```
### Dynamic Port Support
The simple HTTP server supports dynamic port configuration:
```bash
# Use any port you want
node dist/simple-http-server.js 3000
node dist/simple-http-server.js 5000
node dist/simple-http-server.js 9000
node dist/simple-http-server.js 12345
```
The server will automatically:
- Use port 8080 as default if no port is specified
- Accept any valid port number as a command line argument
- Display the actual port in the startup message and documentation
### HTTP API Usage Examples
Once the HTTP server is started, you can use it in the following ways:
#### Browser Access
- Open `http://localhost:8080` to view API documentation
- Click links directly to test various APIs
#### curl Commands
```bash
# Get current weather for Hong Kong
curl "http://localhost:8080/weather?location=Hong Kong"
# Get 5-day weather forecast for Tokyo
curl "http://localhost:8080/forecast?location=Tokyo&days=5"
# Get weather alerts
curl "http://localhost:8080/alerts?location=Hong Kong"
# Search locations
curl "http://localhost:8080/locations?q=kong"
# Get statistics
curl "http://localhost:8080/stats"
```
#### JavaScript/Fetch
```javascript
// Get weather data
const response = await fetch('http://localhost:8080/weather?location=Tokyo');
const weather = await response.json();
console.log(weather);
```
### Development Mode
```bash
# Watch mode compilation
pnpm run dev
```
## Available Tools
### 1. get_current_weather
Get current weather information for a specified location
**Parameters:**
- `location` (string): Location name
**Example:**
```json
{
"location": "Hong Kong"
}
```
### 2. get_weather_forecast
Get weather forecast for a specified location
**Parameters:**
- `location` (string): Location name
- `days` (number, optional): Forecast days (1-7 days, default 3 days)
**Example:**
```json
{
"location": "Tokyo",
"days": 5
}
```
### 3. get_weather_alerts
Get weather alert information
**Parameters:**
- `location` (string, optional): Location name
**Example:**
```json
{
"location": "Hong Kong"
}
```
### 4. search_locations
Search supported locations
**Parameters:**
- `query` (string): Search keyword
**Example:**
```json
{
"query": "kong"
}
```
### 5. get_weather_stats
Get weather statistics
**Parameters:** None
## Supported Locations
Currently supports detailed weather data for the following locations:
- Hong Kong
- Tokyo, Osaka, Kyoto, Hiroshima, Sapporo, Fukuoka (Japan)
- London (UK)
- New York (USA)
- Sydney (Australia)
Other locations will return randomly generated mock data.
## Technical Specifications
- **Language**: TypeScript
- **Package Manager**: pnpm
- **MCP SDK**: @modelcontextprotocol/sdk
- **Node.js**: >=18
## Project Structure
```
src/
āāā index.ts # MCP server main file (stdio)
āāā http-server.ts # HTTP API server
āāā simple-http-server.ts # Simple HTTP server
āāā weather-service.ts # Weather service logic
āāā mock-data.ts # Mock data
āāā types.ts # TypeScript type definitions
```
## HTTP API Endpoints
| Endpoint | Method | Parameters | Description |
|----------|--------|------------|-------------|
| `/` | GET | - | API documentation page |
| `/mcp` | POST | JSON-RPC 2.0 | MCP protocol endpoint |
| `/weather` | GET | location (required) | Get current weather |
| `/forecast` | GET | location (required), days (optional) | Get weather forecast |
| `/alerts` | GET | location (optional) | Get weather alerts |
| `/locations` | GET | q (required) | Search locations |
| `/stats` | GET | - | Get statistics |
## License
MIT License TDQS
Scored across 5 tools
Each tool has a clearly distinct purpose: get_current_weather for current conditions, get_weather_alerts for alerts, get_weather_forecast for forecasts, get_weather_stats for statistics, and search_locations for location lookup. There is no overlap in functionality that would cause confusion.
All tools follow a consistent verb_noun pattern with 'get_' or 'search_' prefixes, using snake_case throughout. The naming is predictable and easy to understand, with no deviations in style.
With 5 tools, this server is well-scoped for a weather service, covering core needs like current weather, alerts, forecasts, statistics, and location search. Each tool earns its place without being overwhelming or insufficient.
The toolset covers essential weather operations comprehensively, including current conditions, forecasts, alerts, and statistics, with a location search to support them. A minor gap might be historical weather data, but the core workflows are well-covered.