get_company_overview
Retrieve comprehensive company profiles from Vietnam's stock market by providing a stock symbol, with output available in JSON or dataframe formats for analysis.
Instructions
Get company overview 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:23-40 (handler)The handler function decorated with @server.tool(), which registers and implements the 'get_company_overview' MCP tool. It fetches the company overview using vnstock's TCBSCompany and returns data as JSON or pandas DataFrame.@server.tool() def get_company_overview( symbol: str, output_format: Literal["json", "dataframe"] = "json" ): """ Get company overview from stock market Args: symbol: str output_format: Literal['json', 'dataframe'] = 'json' Returns: pd.DataFrame """ equity = TCBSCompany(symbol=symbol) df = equity.overview() if output_format == "json": return df.to_json(orient="records", force_ascii=False) else: return df