list_datasets
Retrieve dataset IDs from Hong Kong's official open data portal to explore available public data resources with customizable filters for language and pagination.
Instructions
Get a list of dataset IDs from data.gov.hk
Args: limit: Maximum number of datasets to return (default: 1000) offset: Offset of the first dataset to return language: Language code (en, tc, sc)
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| offset | No | ||
| language | No | en |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Implementation Reference
- src/mcp_open_data_hk/server.py:32-58 (handler)The handler function for the 'list_datasets' tool. It makes an API request to the data.gov.hk package_list endpoint to retrieve a paginated list of dataset IDs. The @mcp.tool decorator registers this function as an MCP tool.
@mcp.tool async def list_datasets( limit: Optional[int] = None, offset: Optional[int] = None, language: str = "en" ) -> List[str]: """ Get a list of dataset IDs from data.gov.hk Args: limit: Maximum number of datasets to return (default: 1000) offset: Offset of the first dataset to return language: Language code (en, tc, sc) """ base_url = BASE_URLS.get(language, BASE_URLS["en"]) url = f"{base_url}/package_list" params = {} if limit is not None: params["limit"] = limit if offset is not None: params["offset"] = offset result = await make_api_request(url, params) if result.get("success"): return result["result"] else: raise Exception(f"API Error: {result.get('error', 'Unknown error')}") - src/mcp_open_data_hk/server.py:19-30 (helper)Helper function used by list_datasets (and other tools) to make HTTP requests to the data.gov.hk API.
async def make_api_request( url: str, params: Optional[Dict[str, Any]] = None ) -> Dict[str, Any]: """Make an API request to data.gov.hk""" async with httpx.AsyncClient() as client: # Print the request for debugging print(f"Making request to {url} with params {params}") response = await client.get(url, params=params) print(f"Response status: {response.status_code}") response.raise_for_status() return response.json() - src/mcp_open_data_hk/server.py:9-13 (helper)Constant defining the base API URLs for different languages used by the list_datasets tool.
BASE_URLS = { "en": "https://data.gov.hk/en-data/api/3/action", "tc": "https://data.gov.hk/tc-data/api/3/action", "sc": "https://data.gov.hk/sc-data/api/3/action", }