VNStock MCP Server

Instructions

Get company ratio summary from stock market
Args:
    symbol: str
    output_format: Literal['json', 'dataframe'] = 'json'
Returns:
    pd.DataFrame

Implementation Reference

• src/vnstock_mcp/server.py:219-237 (handler)

  The handler function implementing the get_company_ratio_summary tool. It is registered via the @server.tool() decorator. The function signature defines the input schema (symbol: str, output_format: Literal["json", "dataframe"] = "json"). It uses VCICompany from vnstock to fetch ratio_summary and returns formatted data.

  @server.tool()
  def get_company_ratio_summary(
      symbol: str, output_format: Literal["json", "dataframe"] = "json"
  ):
      """
      Get company ratio summary from stock market
      Args:
          symbol: str
          output_format: Literal['json', 'dataframe'] = 'json'
      Returns:
          pd.DataFrame
      """
      equity = VCICompany(symbol=symbol)
      df = equity.ratio_summary()
      if output_format == "json":
          return df.to_json(orient="records", force_ascii=False)
      else:
          return df