get_all_symbol_groups
Retrieve all stock symbol groups from the Vietnam market to organize and analyze securities by category. Supports JSON or DataFrame output formats.
Instructions
Get all symbol groups from stock market
Args:
output_format: Literal['json', 'dataframe'] = 'json'
Returns:
pd.DataFrame
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| output_format | No | json |
Implementation Reference
- src/vnstock_mcp/server.py:260-293 (handler)The get_all_symbol_groups tool handler, decorated with @server.tool() for MCP registration. It returns a hardcoded list of all symbol groups as a pandas DataFrame or JSON.@server.tool() def get_all_symbol_groups(output_format: Literal["json", "dataframe"] = "json"): """ Get all symbol groups from stock market Args: output_format: Literal['json', 'dataframe'] = 'json' Returns: pd.DataFrame """ df = pd.DataFrame( [ {"group": "HOSE", "group_name": "All symbols in HOSE"}, {"group": "HNX", "group_name": "All symbols in HNX"}, {"group": "UPCOM", "group_name": "All symbols in UPCOM"}, {"group": "VN30", "group_name": "All symbols in VN30"}, {"group": "VN100", "group_name": "All symbols in VN100"}, {"group": "HNX30", "group_name": "All symbols in HNX30"}, {"group": "VNMidCap", "group_name": "All symbols in VNMidCap"}, {"group": "VNSmallCap", "group_name": "All symbols in VNSmallCap"}, {"group": "VNAllShare", "group_name": "All symbols in VNAllShare"}, {"group": "HNXCon", "group_name": "All symbols in HNXCon"}, {"group": "HNXFin", "group_name": "All symbols in HNXFin"}, {"group": "HNXLCap", "group_name": "All symbols in HNXLCap"}, {"group": "HNXMSCap", "group_name": "All symbols in HNXMSCap"}, {"group": "HNXMan", "group_name": "All symbols in HNXMan"}, {"group": "ETF", "group_name": "All symbols in ETF"}, {"group": "FU_INDEX", "group_name": "All symbols in FU_INDEX"}, {"group": "CW", "group_name": "All symbols in CW"}, ] ) if output_format == "json": return df.to_json(orient="records", force_ascii=False) else: return df
- src/vnstock_mcp/server.py:260-260 (registration)MCP tool registration decorator for get_all_symbol_groups.@server.tool()
- src/vnstock_mcp/server.py:261-268 (schema)Input schema defined by type hints and docstring: output_format as 'json' or 'dataframe', returns pd.DataFrame or JSON string.def get_all_symbol_groups(output_format: Literal["json", "dataframe"] = "json"): """ Get all symbol groups from stock market Args: output_format: Literal['json', 'dataframe'] = 'json' Returns: pd.DataFrame """