Skip to main content
Glama
thuong204

Weather MCP Tool

by thuong204
README.md
# Weather MCP Tool

<p align="center">
  <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="120" alt="Nest Logo" /></a>
</p>

## Description

Weather MCP Tool là một ứng dụng NestJS cung cấp thông tin thời tiết thông qua Model Context Protocol (MCP). Ứng dụng sử dụng OpenWeatherMap API để lấy dữ liệu thời tiết thực tế cho các thành phố trên toàn thế giới.

## Tính năng

- 🌤️ **Thông tin thời tiết thực tế**: Lấy dữ liệu từ OpenWeatherMap API
- 🌍 **Hỗ trợ đa ngôn ngữ**: Mô tả thời tiết bằng tiếng Việt
- 📊 **Thông tin chi tiết**: Nhiệt độ, độ ẩm, tốc độ gió, nhiệt độ cảm giác
- 🔧 **MCP Tool Integration**: Tích hợp với Model Context Protocol
- 🚀 **NestJS Framework**: Xây dựng trên NestJS với TypeScript
- 🐳 **Docker Support**: Hỗ trợ chạy trong Docker container

## Cài đặt

### Cách 1: Cài đặt trực tiếp

```bash
# Clone repository
git clone <repository-url>
cd weather-mcp-nest

# Cài đặt dependencies
npm install
```

### Cách 2: Sử dụng Docker

```bash
# Clone repository
git clone <repository-url>
cd weather-mcp-nest

# Build và chạy với Docker Compose
docker-compose up --build
```

## Cấu hình

1. **Đăng ký OpenWeatherMap API**:
   - Truy cập: https://openweathermap.org/api
   - Đăng ký tài khoản miễn phí
   - Lấy API key

2. **Tạo file .env**:
   ```bash
   OPENWEATHER_API_KEY=your_api_key_here
   ```

## Chạy ứng dụng

### Development Mode

```bash
# Development mode
npm run start:dev

# Production mode
npm run start:prod
```

### Docker Mode

```bash
# Build Docker image
docker build -t weather-mcp .

# Chạy container
docker run -p 3000:3000 --env-file .env weather-mcp

# Hoặc sử dụng Docker Compose
docker-compose up
```

## Sử dụng MCP Tool

Sau khi khởi động server, tool sẽ có sẵn thông qua MCP protocol:

### Tool: `getWeather`

**Mô tả**: Lấy thông tin thời tiết cho một thành phố

**Tham số**:

- `city` (string): Tên thành phố (VD: "Da Nang", "London", "New York")

**Ví dụ sử dụng**:

```json
{
  "name": "getWeather",
  "arguments": {
    "city": "Da Nang"
  }
}
```

**Kết quả**:

```
Thời tiết ở Da Nang: mây cụm, nhiệt độ 28°C (cảm giác như 33°C), độ ẩm 82%, gió 3.49 m/s.
```

## Cấu trúc dự án

```
src/
├── weather/
│   ├── weather.controller.ts    # REST API controller
│   ├── weather.service.ts       # Weather service logic
│   ├── weather.tool.ts          # MCP tool implementation
│   └── weather.module.ts        # Weather module
├── app.module.ts                # Main application module
└── main.ts                      # Application entry point
```

## API Endpoints

### POST /weather

Lấy thông tin thời tiết qua REST API

**Request Body**:

```json
{
  "city": "Da Nang"
}
```

**Response**:

```json
{
  "content": {
    "type": "text",
    "text": "Thời tiết ở Da Nang: mây cụm, nhiệt độ 28°C (cảm giác như 33°C), độ ẩm 82%, gió 3.49 m/s."
  }
}
```

## MCP Configuration

Cấu hình MCP trong `.cursor/mcp.json`:

```json
{
  "mcpServers": {
    "weather": {
      "url": "http://localhost:3000/mcp",
      "type": "http"
    }
  }
}
```

## Dependencies

- **@nestjs/common**: NestJS core framework
- **@rekog/mcp-nest**: MCP integration for NestJS
- **axios**: HTTP client for API calls
- **dotenv**: Environment variables management
- **zod**: Schema validation

## Phát triển

### Chạy tests

```bash
# Unit tests
npm run test

# E2E tests
npm run test:e2e

# Test coverage
npm run test:cov
```

### Linting

```bash
npm run lint
```

## Docker Commands

### Build và chạy

```bash
# Build image
docker build -t weather-mcp .

# Chạy container
docker run -p 3000:3000 --env-file .env weather-mcp

# Chạy với Docker Compose
docker-compose up --build
```

### Quản lý container

```bash
# Xem logs
docker-compose logs -f

# Dừng container
docker-compose down

# Restart container
docker-compose restart
```

### Development với Docker

```bash
# Chạy trong development mode
docker-compose -f docker-compose.dev.yml up
```

## License

MIT License - xem file [LICENSE](LICENSE) để biết thêm chi tiết.

TDQS

B3.4/5.0

Scored across 1 tool

Disambiguation5/5

With only a single tool, there is no possibility of confusion or overlap. The tool's purpose is clearly defined by its name and description.

Naming Consistency5/5

The single tool uses a consistent verb_noun pattern (get_weather). There are no other tools to introduce inconsistency.

Tool Count3/5

One tool is on the low end but can be acceptable for a very narrow scope. However, a weather server typically warrants more than a single tool, so the count feels thin.

Completeness2/5

The tool only supports current weather for a city, but a complete weather domain would also include forecasts, historical data, or alerts. These missing operations represent significant gaps that would force agents to rely on external workarounds.

Maintenance

ActivityInactive
ResponsivenessNo issues