hkopenai.hk-climate-mcp-server 0.1.7__tar.gz → 0.3.0__tar.gz

{hkopenai_hk_climate_mcp_server-0.1.7 → hkopenai_hk_climate_mcp_server-0.3.0}/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 neo@01man.com
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2025 neo@01man.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

hkopenai_hk_climate_mcp_server-0.3.0/PKG-INFO

@@ -0,0 +1,208 @@
+Metadata-Version: 2.4
+Name: hkopenai.hk_climate_mcp_server
+Version: 0.3.0
+Summary: Hong Kong Weather MCP Server providing climate and weather data tools
+Author-email: Neo Chow <neo@01man.com>
+License-Expression: MIT
+Project-URL: repository, https://github.com/hkopenai/hk-climate-mcp-server.git
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastmcp>=0.1.0
+Requires-Dist: requests>=2.31.0
+Requires-Dist: pytest>=8.2.0
+Requires-Dist: pytest-cov>=6.1.1
+Dynamic: license-file
+
+# HK Climate and Weather MCP Server
+
+[![GitHub Repository](https://img.shields.io/badge/GitHub-Repository-blue.svg)](https://github.com/hkopenai/hk-climate-mcp-server)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+
+This is an MCP server that provides access to climate and weather data through a FastMCP interface.
+
+## Data Source
+
+* Hong Kong Observatory 
+
+## Features
+
+- Current weather: Get current weather observations from HKO (supports optional region parameter)
+- 9-day forecast: Get extended weather forecast including general situation, daily forecasts, sea and soil temperatures
+- Local weather forecast: Get short-term weather forecast with outlook
+- Weather warnings: Get summary and detailed information about active weather warnings
+- Special weather tips: Get important weather-related safety tips
+
+## API Reference
+
+### Current Weather
+`get_current_weather(region: str = "Hong Kong Observatory") -> Dict`
+- Get current weather observations for a specific region in Hong Kong
+- Parameters:
+  - region: The region to get weather for (default: "Hong Kong Observatory")
+- Returns:
+  - Dict containing:
+    - warning: Current weather warnings
+    - temperature: Current temperature in Celsius
+    - humidity: Current humidity percentage
+    - rainfall: Current rainfall in mm
+
+### 9-Day Weather Forecast
+`get_9_day_weather_forecast(lang: str = "en") -> Dict`
+- Get the 9-day weather forecast for Hong Kong
+- Parameters:
+  - lang: Language code (en/tc/sc, default: en)
+- Returns:
+  - Dict containing:
+    - generalSituation: General weather situation
+    - weatherForecast: List of daily forecast dicts
+    - updateTime: Last update time
+    - seaTemp: Sea temperature info
+    - soilTemp: List of soil temperature info
+
+### Local Weather Forecast  
+`get_local_weather_forecast(lang: str = "en") -> Dict`
+- Get local weather forecast for Hong Kong
+- Parameters:
+  - lang: Language code (en/tc/sc, default: en)
+- Returns:
+  - Dict containing:
+    - forecastDesc: Forecast description
+    - outlook: Outlook forecast
+    - updateTime: Last update time
+    - forecastPeriod: Forecast period
+    - forecastDate: Forecast date
+
+### Weather Warning Summary
+`get_weather_warning_summary(lang: str = "en") -> Dict`
+- Get weather warning summary for Hong Kong
+- Parameters:
+  - lang: Language code (en/tc/sc, default: en)
+- Returns:
+  - Dict containing:
+    - warningMessage: List of warning messages
+    - updateTime: Last update time
+
+### Weather Warning Information
+`get_weather_warning_info(lang: str = "en") -> Dict`
+- Get detailed weather warning information
+- Parameters:
+  - lang: Language code (en/tc/sc, default: en)
+- Returns:
+  - Dict containing:
+    - warningStatement: Warning statement
+    - updateTime: Last update time
+
+### Special Weather Tips
+`get_special_weather_tips(lang: str = "en") -> Dict`
+- Get special weather tips for Hong Kong
+- Parameters:
+  - lang: Language code (en/tc/sc, default: en)
+- Returns:
+  - Dict containing:
+    - specialWeatherTips: List of special weather tips
+    - updateTime: Last update time
+
+### Visibility Data
+`get_visibility_data(lang: str = "en", rformat: str = "json") -> Dict`
+- Get latest 10-minute mean visibility data for Hong Kong
+- Parameters:
+  - lang: Language code (en/tc/sc, default: en)
+  - rformat: Return format (json/csv, default: json)
+- Returns:
+  - Dict containing visibility data with fields and data arrays
+
+### Lightning Data  
+`get_lightning_data(lang: str = "en", rformat: str = "json") -> Dict`
+- Get cloud-to-ground and cloud-to-cloud lightning count data
+- Parameters:
+  - lang: Language code (en/tc/sc, default: en)
+  - rformat: Return format (json/csv, default: json)
+- Returns:
+  - Dict containing lightning data with fields and data arrays
+
+### Moon Times
+`get_moon_times(year: int, month: Optional[int] = None, day: Optional[int] = None, lang: str = "en", rformat: str = "json") -> Dict`
+- Get times of moonrise, moon transit and moonset
+- Parameters:
+  - year: Year (2018-2024)
+  - month: Optional month (1-12)
+  - day: Optional day (1-31)
+  - lang: Language code (en/tc/sc, default: en)
+  - rformat: Return format (json/csv, default: json)
+- Returns:
+  - Dict containing moon times data with fields and data arrays
+
+### Hourly Tides
+`get_hourly_tides(station: str, year: int, month: Optional[int] = None, day: Optional[int] = None, hour: Optional[int] = None, lang: str = "en", rformat: str = "json") -> Dict`
+- Get hourly heights of astronomical tides for a specific station
+- Parameters:
+  - station: Station code (e.g. 'CCH' for Cheung Chau)
+  - year: Year (2022-2024)
+  - month: Optional month (1-12)
+  - day: Optional day (1-31)
+  - hour: Optional hour (1-24)
+  - lang: Language code (en/tc/sc, default: en)
+  - rformat: Return format (json/csv, default: json)
+- Returns:
+  - Dict containing tide data with fields and data arrays
+
+### High/Low Tides
+`get_high_low_tides(station: str, year: int, month: Optional[int] = None, day: Optional[int] = None, hour: Optional[int] = None, lang: str = "en", rformat: str = "json") -> Dict`
+- Get times and heights of astronomical high and low tides
+- Parameters:
+  - station: Station code (e.g. 'CCH' for Cheung Chau)
+  - year: Year (2022-2024)
+  - month: Optional month (1-12)
+  - day: Optional day (1-31)
+  - hour: Optional hour (1-24)
+  - lang: Language code (en/tc/sc, default: en)
+  - rformat: Return format (json/csv, default: json)
+- Returns:
+  - Dict containing tide data with fields and data arrays
+
+## Setup
+
+1. Clone this repository
+2. Install Python dependencies:
+   ```bash
+   pip install -r requirements.txt
+   ```
+3. Run the server:
+   ```bash
+   python app.py
+   ```
+
+### Running Options
+
+- Default stdio mode: `python app.py`
+- SSE mode (port 8000): `python app.py --sse`
+
+## Cline Integration
+
+To connect this MCP server to Cline using stdio:
+
+1. Add this configuration to your Cline MCP settings (cline_mcp_settings.json):
+```json
+{
+  "hko-server": {
+    "disabled": false,
+    "timeout": 3,
+    "type": "stdio",
+    "command": "python",
+    "args": [
+      "-m",
+      "hkopenai.hk_climate_mcp_server"
+    ]
+  }
+}
+```
+
+## Testing
+
+Tests are available in `tests`. Run with:
+```bash
+pytest

hkopenai_hk_climate_mcp_server-0.3.0/README.md

@@ -0,0 +1,190 @@
+# HK Climate and Weather MCP Server
+
+[![GitHub Repository](https://img.shields.io/badge/GitHub-Repository-blue.svg)](https://github.com/hkopenai/hk-climate-mcp-server)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+
+This is an MCP server that provides access to climate and weather data through a FastMCP interface.
+
+## Data Source
+
+* Hong Kong Observatory 
+
+## Features
+
+- Current weather: Get current weather observations from HKO (supports optional region parameter)
+- 9-day forecast: Get extended weather forecast including general situation, daily forecasts, sea and soil temperatures
+- Local weather forecast: Get short-term weather forecast with outlook
+- Weather warnings: Get summary and detailed information about active weather warnings
+- Special weather tips: Get important weather-related safety tips
+
+## API Reference
+
+### Current Weather
+`get_current_weather(region: str = "Hong Kong Observatory") -> Dict`
+- Get current weather observations for a specific region in Hong Kong
+- Parameters:
+  - region: The region to get weather for (default: "Hong Kong Observatory")
+- Returns:
+  - Dict containing:
+    - warning: Current weather warnings
+    - temperature: Current temperature in Celsius
+    - humidity: Current humidity percentage
+    - rainfall: Current rainfall in mm
+
+### 9-Day Weather Forecast
+`get_9_day_weather_forecast(lang: str = "en") -> Dict`
+- Get the 9-day weather forecast for Hong Kong
+- Parameters:
+  - lang: Language code (en/tc/sc, default: en)
+- Returns:
+  - Dict containing:
+    - generalSituation: General weather situation
+    - weatherForecast: List of daily forecast dicts
+    - updateTime: Last update time
+    - seaTemp: Sea temperature info
+    - soilTemp: List of soil temperature info
+
+### Local Weather Forecast  
+`get_local_weather_forecast(lang: str = "en") -> Dict`
+- Get local weather forecast for Hong Kong
+- Parameters:
+  - lang: Language code (en/tc/sc, default: en)
+- Returns:
+  - Dict containing:
+    - forecastDesc: Forecast description
+    - outlook: Outlook forecast
+    - updateTime: Last update time
+    - forecastPeriod: Forecast period
+    - forecastDate: Forecast date
+
+### Weather Warning Summary
+`get_weather_warning_summary(lang: str = "en") -> Dict`
+- Get weather warning summary for Hong Kong
+- Parameters:
+  - lang: Language code (en/tc/sc, default: en)
+- Returns:
+  - Dict containing:
+    - warningMessage: List of warning messages
+    - updateTime: Last update time
+
+### Weather Warning Information
+`get_weather_warning_info(lang: str = "en") -> Dict`
+- Get detailed weather warning information
+- Parameters:
+  - lang: Language code (en/tc/sc, default: en)
+- Returns:
+  - Dict containing:
+    - warningStatement: Warning statement
+    - updateTime: Last update time
+
+### Special Weather Tips
+`get_special_weather_tips(lang: str = "en") -> Dict`
+- Get special weather tips for Hong Kong
+- Parameters:
+  - lang: Language code (en/tc/sc, default: en)
+- Returns:
+  - Dict containing:
+    - specialWeatherTips: List of special weather tips
+    - updateTime: Last update time
+
+### Visibility Data
+`get_visibility_data(lang: str = "en", rformat: str = "json") -> Dict`
+- Get latest 10-minute mean visibility data for Hong Kong
+- Parameters:
+  - lang: Language code (en/tc/sc, default: en)
+  - rformat: Return format (json/csv, default: json)
+- Returns:
+  - Dict containing visibility data with fields and data arrays
+
+### Lightning Data  
+`get_lightning_data(lang: str = "en", rformat: str = "json") -> Dict`
+- Get cloud-to-ground and cloud-to-cloud lightning count data
+- Parameters:
+  - lang: Language code (en/tc/sc, default: en)
+  - rformat: Return format (json/csv, default: json)
+- Returns:
+  - Dict containing lightning data with fields and data arrays
+
+### Moon Times
+`get_moon_times(year: int, month: Optional[int] = None, day: Optional[int] = None, lang: str = "en", rformat: str = "json") -> Dict`
+- Get times of moonrise, moon transit and moonset
+- Parameters:
+  - year: Year (2018-2024)
+  - month: Optional month (1-12)
+  - day: Optional day (1-31)
+  - lang: Language code (en/tc/sc, default: en)
+  - rformat: Return format (json/csv, default: json)
+- Returns:
+  - Dict containing moon times data with fields and data arrays
+
+### Hourly Tides
+`get_hourly_tides(station: str, year: int, month: Optional[int] = None, day: Optional[int] = None, hour: Optional[int] = None, lang: str = "en", rformat: str = "json") -> Dict`
+- Get hourly heights of astronomical tides for a specific station
+- Parameters:
+  - station: Station code (e.g. 'CCH' for Cheung Chau)
+  - year: Year (2022-2024)
+  - month: Optional month (1-12)
+  - day: Optional day (1-31)
+  - hour: Optional hour (1-24)
+  - lang: Language code (en/tc/sc, default: en)
+  - rformat: Return format (json/csv, default: json)
+- Returns:
+  - Dict containing tide data with fields and data arrays
+
+### High/Low Tides
+`get_high_low_tides(station: str, year: int, month: Optional[int] = None, day: Optional[int] = None, hour: Optional[int] = None, lang: str = "en", rformat: str = "json") -> Dict`
+- Get times and heights of astronomical high and low tides
+- Parameters:
+  - station: Station code (e.g. 'CCH' for Cheung Chau)
+  - year: Year (2022-2024)
+  - month: Optional month (1-12)
+  - day: Optional day (1-31)
+  - hour: Optional hour (1-24)
+  - lang: Language code (en/tc/sc, default: en)
+  - rformat: Return format (json/csv, default: json)
+- Returns:
+  - Dict containing tide data with fields and data arrays
+
+## Setup
+
+1. Clone this repository
+2. Install Python dependencies:
+   ```bash
+   pip install -r requirements.txt
+   ```
+3. Run the server:
+   ```bash
+   python app.py
+   ```
+
+### Running Options
+
+- Default stdio mode: `python app.py`
+- SSE mode (port 8000): `python app.py --sse`
+
+## Cline Integration
+
+To connect this MCP server to Cline using stdio:
+
+1. Add this configuration to your Cline MCP settings (cline_mcp_settings.json):
+```json
+{
+  "hko-server": {
+    "disabled": false,
+    "timeout": 3,
+    "type": "stdio",
+    "command": "python",
+    "args": [
+      "-m",
+      "hkopenai.hk_climate_mcp_server"
+    ]
+  }
+}
+```
+
+## Testing
+
+Tests are available in `tests`. Run with:
+```bash
+pytest

hkopenai_hk_climate_mcp_server-0.3.0/hkopenai/hk_climate_mcp_server/__init__.py

@@ -0,0 +1,43 @@
+"""Hong Kong climate MCP Server package."""
+from .app import main
+from .tool_weather import (
+    get_current_weather,
+    get_9_day_weather_forecast,
+    get_local_weather_forecast,
+    get_weather_warning_summary,
+    get_weather_warning_info,
+    get_special_weather_tips,
+    get_visibility_data,
+    get_lightning_data,
+    get_moon_times,
+    get_hourly_tides,
+    get_high_low_tides,
+    get_sunrise_sunset_times,
+    get_gregorian_lunar_calendar,
+    get_daily_mean_temperature,
+    get_daily_max_temperature,
+    get_daily_min_temperature,
+    get_weather_radiation_report
+)
+
+__version__ = "0.1.0"
+__all__ = [
+    'main',
+    'get_current_weather',
+    'get_9_day_weather_forecast',
+    'get_local_weather_forecast',
+    'get_weather_warning_summary',
+    'get_weather_warning_info',
+    'get_special_weather_tips',
+    'get_visibility_data',
+    'get_lightning_data',
+    'get_moon_times',
+    'get_hourly_tides',
+    'get_high_low_tides',
+    'get_sunrise_sunset_times',
+    'get_gregorian_lunar_calendar',
+    'get_daily_mean_temperature',
+    'get_daily_max_temperature',
+    'get_daily_min_temperature',
+    'get_weather_radiation_report'
+]

{hkopenai_hk_climate_mcp_server-0.1.7 → hkopenai_hk_climate_mcp_server-0.3.0}/hkopenai/hk_climate_mcp_server/__main__.py

@@ -1,4 +1,4 @@
-from hkopenai.hk_climate_mcp_server.app import main
-
-if __name__ == "__main__":
-    main()
+from hkopenai.hk_climate_mcp_server.app import main
+
+if __name__ == "__main__":
+    main()