get_company_dividends
Retrieve dividend history for Vietnam-listed companies by stock symbol, returning data in JSON or dataframe format for financial analysis.
Instructions
Get company dividends from stock market
Args:
symbol: str
output_format: Literal['json', 'dataframe'] = 'json'
Returns:
pd.DataFrame
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| symbol | Yes | ||
| output_format | No | json |
Implementation Reference
- src/vnstock_mcp/server.py:179-196 (handler)Handler function for get_company_dividends tool. Uses TCBSCompany to fetch dividends data and returns as JSON or DataFrame.@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
- src/vnstock_mcp/server.py:179-179 (registration)Registers the get_company_dividends function as an MCP tool using FastMCP decorator.@server.tool()
- src/vnstock_mcp/server.py:180-182 (schema)Input schema defined by function parameters: symbol (str), output_format (Literal["json", "dataframe"] = "json"). Output is pd.DataFrame or JSON string.def get_company_dividends( symbol: str, output_format: Literal["json", "dataframe"] = "json" ):