Merge pull request #14 from zwldarren/dev

feat(server): add financial metrics tool and more indicator support

Author: zwldarren

README.md

@@ -17,7 +17,7 @@ An MCP server based on [akshare-one](https://github.com/zwldarren/akshare-one),
 
 ### `get_hist_data`
 
-Get historical stock market data.
+Get historical stock market data. 'eastmoney_direct' supports all A, B, H shares.
 
 - symbol (string): Stock code (e.g. '000001')
 - interval (string): Time interval ('minute','hour','day','week','month','year') (default: 'day')
@@ -26,49 +26,57 @@ Get historical stock market data.
 - end_date (string, optional): End date in YYYY-MM-DD format (default: '2030-12-31')
 - adjust (string, optional): Adjustment type ('none', 'qfq', 'hfq') (default: 'none')
 - source (string, optional): Data source ('eastmoney', 'eastmoney_direct', 'sina') (default: 'eastmoney')
-- indicators_list (list, optional): Technical indicators to add (e.g. ['SMA', 'EMA', 'RSI', 'MACD', 'BOLL', 'STOCH', 'ATR', 'CCI', 'ADX'])
+- indicators_list (list, optional): Technical indicators to add (e.g. ['SMA', 'EMA', 'RSI', 'MACD', 'BOLL', 'STOCH', 'ATR', 'CCI', 'ADX', 'WILLR', 'AD', 'ADOSC', 'OBV', 'MOM', 'SAR', 'TSF', 'APO', 'AROON', 'AROONOSC', 'BOP', 'CMO', 'DX', 'MFI', 'MINUS_DI', 'MINUS_DM', 'PLUS_DI', 'PLUS_DM', 'PPO', 'ROC', 'ROCP', 'ROCR', 'ROCR100', 'TRIX', 'ULTOSC'])
 - recent_n (number, optional): Number of most recent records to return (default: 100)
 
 ### `get_realtime_data`
 
-Get real-time stock data
+Get real-time stock market data. 'eastmoney_direct' supports all A, B, H shares.
 
 - symbol (string, optional): Stock code
-- source (string, optional): Data source ('xueqiu', 'eastmoney_direct') (default: 'xueqiu')
+- source (string, optional): Data source ('xueqiu', 'eastmoney', 'eastmoney_direct') (default: 'eastmoney_direct')
 
 ### `get_news_data`
 
-Get stock-related news data
+Get stock-related news data.
 
 - symbol (string): Stock code
-- recent_n (number, optional): Number of most recent records to return (optional)
+- recent_n (number, optional): Number of most recent records to return (default: 10)
 
 ### `get_balance_sheet`
 
-Get company balance sheet data
+Get company balance sheet data.
 
 - symbol (string): Stock code
-- recent_n (number, optional): Number of most recent records to return (optional)
+- recent_n (number, optional): Number of most recent records to return (default: 10)
 
 ### `get_income_statement`
 
-Get company income statement data
+Get company income statement data.
 
 - symbol (string): Stock code
-- recent_n (number, optional): Number of most recent records to return (optional)
+- recent_n (number, optional): Number of most recent records to return (default: 10)
 
 ### `get_cash_flow`
 
-Get company cash flow statement data
+Get company cash flow statement data.
 
 - symbol (string): Stock code
 - source (string, optional): Data source (default: 'sina')
+- recent_n (number, optional): Number of most recent records to return (default: 10)
 
 ### `get_inner_trade_data`
 
-Get company insider trading data
+Get company insider trading data.
 
-- symbol (string, optional): Stock code
+- symbol (string): Stock code
+
+### `get_financial_metrics`
+
+Get key financial metrics from the three major financial statements.
+
+- symbol (string): Stock code
+- recent_n (number, optional): Number of most recent records to return (default: 10)
 
 ### `get_time_info`
 

README_zh.md

@@ -17,58 +17,66 @@
 
 ### `get_hist_data`
 
-获取历史股票市场数据。
+获取历史股票市场数据。'eastmoney_direct' 支持所有 A、B、H 股
 
 - symbol (字符串): 股票代码 (例如 '000001')
 - interval (字符串): 时间间隔 ('minute','hour','day','week','month','year') (默认: 'day')
-- interval_multiplier (数字, 可选): 间隔倍数 (默认: 1)
-- start_date (字符串, 可选): 开始日期 YYYY-MM-DD 格式 (默认: '1970-01-01')
-- end_date (字符串, 可选): 结束日期 YYYY-MM-DD 格式 (默认: '2030-12-31')
-- adjust (字符串, 可选): 调整类型 ('none', 'qfq', 'hfq') (默认: 'none')
-- source (字符串, 可选): 数据源 ('eastmoney', 'eastmoney_direct', 'sina') (默认: 'eastmoney')
-- indicators_list (列表, 可选): 技术指标 (例如 ['SMA', 'EMA', 'RSI', 'MACD', 'BOLL', 'STOCH', 'ATR', 'CCI', 'ADX'])
+- interval_multiplier (数字): 间隔倍数 (默认: 1)
+- start_date (字符串): 开始日期 YYYY-MM-DD 格式 (默认: '1970-01-01')
+- end_date (字符串): 结束日期 YYYY-MM-DD 格式 (默认: '2030-12-31')
+- adjust (字符串): 调整类型 ('none', 'qfq', 'hfq') (默认: 'none')
+- source (字符串): 数据源 ('eastmoney', 'eastmoney_direct', 'sina') (默认: 'eastmoney')
+- indicators_list (列表, 可选): 技术指标 (例如 ['SMA', 'EMA', 'RSI', 'MACD', 'BOLL', 'STOCH', 'ATR', 'CCI', 'ADX', 'WILLR', 'AD', 'ADOSC', 'OBV', 'MOM', 'SAR', 'TSF', 'APO', 'AROON', 'AROONOSC', 'BOP', 'CMO', 'DX', 'MFI', 'MINUS_DI', 'MINUS_DM', 'PLUS_DI', 'PLUS_DM', 'PPO', 'ROC', 'ROCP', 'ROCR', 'ROCR100', 'TRIX', 'ULTOSC'])
 - recent_n (数字, 可选): 返回最近记录的数量 (默认: 100)
 
 ### `get_realtime_data`
 
-获取实时股票数据
+获取实时股票市场数据。'eastmoney_direct' 支持所有 A、B、H 股
 
 - symbol (字符串, 可选): 股票代码
-- source (字符串, 可选): 数据源 ('xueqiu', 'eastmoney_direct') (默认: 'xueqiu')
+- source (字符串): 数据源 ('xueqiu', 'eastmoney', 'eastmoney_direct') (默认: 'eastmoney_direct')
 
 ### `get_news_data`
 
-获取股票相关新闻数据
+获取股票相关新闻数据。
 
 - symbol (字符串): 股票代码
-- recent_n (数字, 可选): 返回最近记录的数量 (可选)
+- recent_n (数字, 可选): 返回最近记录的数量 (默认: 10)
 
 ### `get_balance_sheet`
 
-获取公司资产负债表数据
+获取公司资产负债表数据。
 
 - symbol (字符串): 股票代码
-- recent_n (数字, 可选): 返回最近记录的数量 (可选)
+- recent_n (数字, 可选): 返回最近记录的数量 (默认: 10)
 
 ### `get_income_statement`
 
-获取公司利润表数据
+获取公司利润表数据。
 
 - symbol (字符串): 股票代码
-- recent_n (数字, 可选): 返回最近记录的数量 (可选)
+- recent_n (数字, 可选): 返回最近记录的数量 (默认: 10)
 
 ### `get_cash_flow`
 
-获取公司现金流量表数据
+获取公司现金流量表数据。
 
 - symbol (字符串): 股票代码
-- source (字符串, 可选): 数据源 (默认: 'sina')
+- source (字符串): 数据源 (默认: 'sina')
+- recent_n (数字, 可选): 返回最近记录的数量 (默认: 10)
 
 ### `get_inner_trade_data`
 
-获取公司内部交易数据
+获取公司内部交易数据。
 
-- symbol (字符串, 可选): 股票代码
+- symbol (字符串): 股票代码
+
+### `get_financial_metrics`
+
+获取三大财务报表的关键财务指标。
+
+- symbol (字符串): 股票代码
+- recent_n (数字, 可选): 返回最近记录的数量 (默认: 10)
 
 ### `get_time_info`
 

pyproject.toml

@@ -1,13 +1,13 @@
 [project]
 name = "akshare-one-mcp"
-version = "0.2.3"
+version = "0.3.0"
 description = "MCP server that provides access to Chinese stock market data using akshare-one"
 readme = "README.md"
 license = { text = "MIT" }
 authors = [{ name = "zwldarren", email = "zwldarren@gmail.com" }]
 requires-python = ">=3.12"
 dependencies = [
-    "akshare-one>=0.3.6",
+    "akshare-one>=0.3.7",
     "fastmcp>=2.9.2",
 ]
 keywords = ["akshare", "stock", "mcp", "mcp-server"]

src/akshare_one_mcp/server.py

@@ -46,6 +46,31 @@ def get_hist_data(
                 "ATR",
                 "CCI",
                 "ADX",
+                "WILLR",
+                "AD",
+                "ADOSC",
+                "OBV",
+                "MOM",
+                "SAR",
+                "TSF",
+                "APO",
+                "AROON",
+                "AROONOSC",
+                "BOP",
+                "CMO",
+                "DX",
+                "MFI",
+                "MINUS_DI",
+                "MINUS_DM",
+                "PLUS_DI",
+                "PLUS_DM",
+                "PPO",
+                "ROC",
+                "ROCP",
+                "ROCR",
+                "ROCR100",
+                "TRIX",
+                "ULTOSC",
             ]
         ]
         | None,
@@ -79,6 +104,40 @@ def get_hist_data(
             "ATR": (indicators.get_atr, {"window": 14}),
             "CCI": (indicators.get_cci, {"window": 14}),
             "ADX": (indicators.get_adx, {"window": 14}),
+            "WILLR": (indicators.get_willr, {"window": 14}),
+            "AD": (indicators.get_ad, {}),
+            "ADOSC": (indicators.get_adosc, {"fast_period": 3, "slow_period": 10}),
+            "OBV": (indicators.get_obv, {}),
+            "MOM": (indicators.get_mom, {"window": 10}),
+            "SAR": (indicators.get_sar, {"acceleration": 0.02, "maximum": 0.2}),
+            "TSF": (indicators.get_tsf, {"window": 14}),
+            "APO": (
+                indicators.get_apo,
+                {"fast_period": 12, "slow_period": 26, "ma_type": 0},
+            ),
+            "AROON": (indicators.get_aroon, {"window": 14}),
+            "AROONOSC": (indicators.get_aroonosc, {"window": 14}),
+            "BOP": (indicators.get_bop, {}),
+            "CMO": (indicators.get_cmo, {"window": 14}),
+            "DX": (indicators.get_dx, {"window": 14}),
+            "MFI": (indicators.get_mfi, {"window": 14}),
+            "MINUS_DI": (indicators.get_minus_di, {"window": 14}),
+            "MINUS_DM": (indicators.get_minus_dm, {"window": 14}),
+            "PLUS_DI": (indicators.get_plus_di, {"window": 14}),
+            "PLUS_DM": (indicators.get_plus_dm, {"window": 14}),
+            "PPO": (
+                indicators.get_ppo,
+                {"fast_period": 12, "slow_period": 26, "ma_type": 0},
+            ),
+            "ROC": (indicators.get_roc, {"window": 10}),
+            "ROCP": (indicators.get_rocp, {"window": 10}),
+            "ROCR": (indicators.get_rocr, {"window": 10}),
+            "ROCR100": (indicators.get_rocr100, {"window": 10}),
+            "TRIX": (indicators.get_trix, {"window": 30}),
+            "ULTOSC": (
+                indicators.get_ultosc,
+                {"window1": 7, "window2": 14, "window3": 28},
+            ),
         }
         temp = []
         for indicator in indicators_list:
@@ -174,6 +233,22 @@ def get_inner_trade_data(
     return df.to_json(orient="records")
 
 
+@mcp.tool
+def get_financial_metrics(
+    symbol: Annotated[str, Field(description="Stock symbol/ticker (e.g. '000001')")],
+    recent_n: Annotated[
+        int | None, Field(description="Number of most recent records to return", ge=1)
+    ] = 10,
+) -> str:
+    """
+    Get key financial metrics from the three major financial statements.
+    """
+    df = ako.get_financial_metrics(symbol)
+    if recent_n is not None:
+        df = df.head(recent_n)
+    return df.to_json(orient="records")
+
+
 @mcp.tool
 def get_time_info() -> dict:
     """Get current time with ISO format, timestamp, and the last trading day."""