Introduction

In the DSH plugin ecosystem, data access for specific regional markets often needs to be handled by developers on their own. xby-vnstock is a networked tool plugin for the Vietnamese market, designed to fill the gap in Vietnamese stock market data access within DSH.

This plugin is an unofficial MCP server that provides interfaces for accessing Vietnam stock exchange data, including real-time and historical stock prices, company financial data, market statistics, and fund information.

Core Functions

The tools provided by the plugin are mainly divided into five categories: market data, company details, financial statements, fund information, and system configuration.

Market Data

  • list_all_icb_industries: Retrieves all ICB industry classifications.
  • list_all_companies_with_details: Lists all companies in the market with details.
  • get_all_symbol_groups: Retrieves all stock symbol groups.
  • get_all_symbols_by_group: Retrieves all stock symbols by group.
  • get_all_symbols_by_industry: Retrieves all stock symbols by ICB industry.
  • get_all_symbols: Retrieves all stock symbols.
  • get_all_symbols_detailed: Retrieves detailed information for all stock symbols.
  • get_gold_price: Retrieves gold prices.

Company Details

  • get_company_overview: Retrieves a company overview.
  • get_company_news: Retrieves company news.
  • get_company_events: Retrieves major company events.
  • get_company_shareholders: Retrieves company shareholder information.
  • get_company_officers: Retrieves company officer information (can filter active or departed).
  • get_company_subsidiaries: Retrieves company subsidiary information.
  • get_company_reports: Retrieves company reports.
  • get_company_dividends: Retrieves company dividend information.
  • get_company_insider_deals: Retrieves company insider transaction data.
  • get_company_ratio_summary: Retrieves a summary of company financial ratios.
  • get_company_trading_stats: Retrieves company trading statistics.

Financial Statements

  • get_income_statements: Retrieves income statements (supports quarterly or annual).
  • get_balance_sheets: Retrieves balance sheets (supports quarterly or annual).
  • get_cash_flows: Retrieves cash flow statements (supports quarterly or annual).
  • get_finance_ratios: Retrieves financial ratios.
  • get_raw_report: Retrieves raw reports.

Fund Information

  • list_all_funds: Lists all funds (can filter by type).
  • search_fund: Searches funds by keyword.
  • get_fund_nav_report: Retrieves a fund NAV report.
  • get_fund_top_holding: Retrieves the top ten holdings of a fund.
  • get_fund_industry_holding: Retrieves a fund’s industry holdings.
  • get_fund_asset_holding: Retrieves a fund’s asset holdings.

System Configuration

  • set_xby_apikey: Sets the API key (automatically persisted and remains valid after restart).

Typical Usage

Before using this plugin, you usually need to set the API key first to pass authentication.

Retrieving a Company Overview

Call the get_company_overview tool, passing the company code symbol and output format.

Retrieving Financial Statements

When retrieving balance sheets or income statements, specify the period parameter ('quarter' or 'year').

Retrieving Fund Information

First search for the target fund with search_fund, then call get_fund_nav_report to retrieve detailed NAV data.

Installation and Activation

There is no official specific installation command. This plugin is maintained by xby-skill and can be obtained from the directory page or the GitHub repository.

  • Directory page: https://www.skillhub.cn/plugins/xby-skill/xby-vnstock
  • GitHub: https://github.com/xby-skill/xby-vnstock

Applicable Scenarios and Precautions

  • Applicable scenarios: Suitable for developers who need to perform Vietnamese market analysis, company financial research, or fund investment.
  • Precautions:
    • This plugin is an unofficial MCP server; data source reliability should be evaluated by yourself.
    • The plugin runs with the permissions of the current DSH process; it is recommended to review the source code and license (MIT) before use.
    • Output formats support json, dataframe, and toon (an AI-optimized format).

Summary

xby-vnstock adds a Vietnamese stock market data dimension to the DSH plugin ecosystem. By providing a complete toolchain from macro industry classifications to micro-level company financial statements, it can help developers build intelligent analysis applications for the Vietnamese market. For more details, refer to GitHub.