VNStock MCP Server

Instructions

Get all symbols from stock market
Args:
    group: str (group name to get symbols)
    output_format: Literal['json', 'dataframe'] = 'json'
Returns:
    pd.DataFrame

Implementation Reference

• src/vnstock_mcp/server.py:313-331 (handler)

  The handler function for the get_all_symbols_by_group tool. It is registered via the @server.tool() decorator and implements the core logic using VCIListing to fetch symbols by group, supporting JSON or DataFrame output.

  @server.tool()
  def get_all_symbols_by_group(
      group: str, output_format: Literal["json", "dataframe"] = "json"
  ):
      """
      Get all symbols from stock market
      Args:
          group: str (group name to get symbols)
          output_format: Literal['json', 'dataframe'] = 'json'
      Returns:
          pd.DataFrame
      """
      listing = VCIListing()
      df = listing.symbols_by_group(group=group)
      if output_format == "json":
          return df.to_json(orient="records", force_ascii=False)
      else:
          return df

• src/vnstock_mcp/server.py:313-313 (registration)

  The @server.tool() decorator registers the get_all_symbols_by_group function as an MCP tool.

  @server.tool()

• src/vnstock_mcp/server.py:315-322 (schema)

  Type hints and docstring define the input schema (group: str, output_format: Literal) and output (pd.DataFrame or JSON).

      group: str, output_format: Literal["json", "dataframe"] = "json"
  ):
      """
      Get all symbols from stock market
      Args:
          group: str (group name to get symbols)
          output_format: Literal['json', 'dataframe'] = 'json'
      Returns: