get_company_dividends
Retrieve dividend payment history for Vietnam-listed companies by stock symbol, returning data in JSON or dataframe format.
Instructions
Get company dividends from stock market
Args:
symbol: str
output_format: Literal['json', 'dataframe'] = 'json'
Returns:
pd.DataFrameInput Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| symbol | Yes | ||
| output_format | No | json |
Implementation Reference
- src/vnstock_mcp/server.py:179-196 (handler)The primary handler and registration for the 'get_company_dividends' MCP tool. It fetches dividends data using vnstock's TCBSCompany.dividends() method and supports JSON or DataFrame output formats.
@server.tool() def get_company_dividends( symbol: str, output_format: Literal["json", "dataframe"] = "json" ): """ Get company dividends from stock market Args: symbol: str output_format: Literal['json', 'dataframe'] = 'json' Returns: pd.DataFrame """ equity = TCBSCompany(symbol=symbol) df = equity.dividends() if output_format == "json": return df.to_json(orient="records", force_ascii=False) else: return df