Skip to content

Commit 1ea213a

Browse files
zwldarrenzwldarren
authored
Merge pull request #24 from zwldarren/dev
upgrade version to 0.3.4
2 parents 3eacd0b + 9d4e555 commit 1ea213a

File tree

4 files changed

+310
-170
lines changed

4 files changed

+310
-170
lines changed

‎README.md‎

Lines changed: 143 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -7,82 +7,123 @@
77

88
[![smithery badge](https://smithery.ai/badge/@zwldarren/akshare-one-mcp)](https://smithery.ai/server/@zwldarren/akshare-one-mcp)
99

10-
An MCP server based on [akshare-one](https://github.com/zwldarren/akshare-one), providing interfaces for China stock market data. It offers a set of tools for retrieving financial information including historical stock data, real-time data, news data, financial statements, etc.
10+
## Overview
11+
12+
An MCP server based on [akshare-one](https://github.com/zwldarren/akshare-one), providing comprehensive interfaces for China stock market data. It offers a set of powerful tools for retrieving financial information including historical stock data, real-time data, news data, and financial statements.
1113

1214
<a href="https://glama.ai/mcp/servers/@zwldarren/akshare-one-mcp">
1315
<img width="380" height="200" src="https://glama.ai/mcp/servers/@zwldarren/akshare-one-mcp/badge" alt="akshare-one-mcp MCP server" />
1416
</a>
1517

16-
## Tools
18+
## Available Tools
19+
20+
### Market Data Tools
21+
22+
#### `get_hist_data`
23+
Get historical stock market data with support for multiple time periods and adjustment methods.
24+
25+
<details>
26+
<summary>Parameters</summary>
1727

18-
### `get_hist_data`
28+
- `symbol` (string, required): Stock code (e.g. '000001')
29+
- `interval` (string, optional): Time interval ('minute','hour','day','week','month','year') (default: 'day')
30+
- `interval_multiplier` (number, optional): Interval multiplier (default: 1)
31+
- `start_date` (string, optional): Start date in YYYY-MM-DD format (default: '1970-01-01')
32+
- `end_date` (string, optional): End date in YYYY-MM-DD format (default: '2030-12-31')
33+
- `adjust` (string, optional): Adjustment type ('none', 'qfq', 'hfq') (default: 'none')
34+
- `source` (string, optional): Data source ('eastmoney', 'eastmoney_direct', 'sina') (default: 'eastmoney')
35+
- `indicators_list` (list, optional): Technical indicators to add
36+
- `recent_n` (number, optional): Number of most recent records to return (default: 100)
1937

20-
Get historical stock market data. 'eastmoney_direct' supports all A, B, H shares.
38+
</details>
2139

22-
- symbol (string): Stock code (e.g. '000001')
23-
- interval (string): Time interval ('minute','hour','day','week','month','year') (default: 'day')
24-
- interval_multiplier (number, optional): Interval multiplier (default: 1)
25-
- start_date (string, optional): Start date in YYYY-MM-DD format (default: '1970-01-01')
26-
- end_date (string, optional): End date in YYYY-MM-DD format (default: '2030-12-31')
27-
- adjust (string, optional): Adjustment type ('none', 'qfq', 'hfq') (default: 'none')
28-
- source (string, optional): Data source ('eastmoney', 'eastmoney_direct', 'sina') (default: 'eastmoney')
29-
- 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'])
30-
- recent_n (number, optional): Number of most recent records to return (default: 100)
40+
#### `get_realtime_data`
41+
Get real-time stock market data.
3142

32-
### `get_realtime_data`
43+
<details>
44+
<summary>Parameters</summary>
3345

34-
Get real-time stock market data. 'eastmoney_direct' supports all A, B, H shares.
46+
- `symbol` (string, optional): Stock code
47+
- `source` (string, optional): Data source ('xueqiu', 'eastmoney', 'eastmoney_direct') (default: 'eastmoney_direct')
3548

36-
- symbol (string, optional): Stock code
37-
- source (string, optional): Data source ('xueqiu', 'eastmoney', 'eastmoney_direct') (default: 'eastmoney_direct')
49+
</details>
3850

39-
### `get_news_data`
51+
### News & Information Tools
4052

53+
#### `get_news_data`
4154
Get stock-related news data.
4255

43-
- symbol (string): Stock code
44-
- recent_n (number, optional): Number of most recent records to return (default: 10)
56+
<details>
57+
<summary>Parameters</summary>
4558

46-
### `get_balance_sheet`
59+
- `symbol` (string, required): Stock code
60+
- `recent_n` (number, optional): Number of most recent records to return (default: 10)
4761

62+
</details>
63+
64+
### Financial Statement Tools
65+
66+
#### `get_balance_sheet`
4867
Get company balance sheet data.
4968

50-
- symbol (string): Stock code
51-
- recent_n (number, optional): Number of most recent records to return (default: 10)
69+
<details>
70+
<summary>Parameters</summary>
5271

53-
### `get_income_statement`
72+
- `symbol` (string, required): Stock code
73+
- `recent_n` (number, optional): Number of most recent records to return (default: 10)
5474

75+
</details>
76+
77+
#### `get_income_statement`
5578
Get company income statement data.
5679

57-
- symbol (string): Stock code
58-
- recent_n (number, optional): Number of most recent records to return (default: 10)
80+
<details>
81+
<summary>Parameters</summary>
82+
83+
- `symbol` (string, required): Stock code
84+
- `recent_n` (number, optional): Number of most recent records to return (default: 10)
5985

60-
### `get_cash_flow`
86+
</details>
6187

88+
#### `get_cash_flow`
6289
Get company cash flow statement data.
6390

64-
- symbol (string): Stock code
65-
- source (string, optional): Data source (default: 'sina')
66-
- recent_n (number, optional): Number of most recent records to return (default: 10)
91+
<details>
92+
<summary>Parameters</summary>
6793

68-
### `get_inner_trade_data`
94+
- `symbol` (string, required): Stock code
95+
- `source` (string, optional): Data source (default: 'sina')
96+
- `recent_n` (number, optional): Number of most recent records to return (default: 10)
6997

98+
</details>
99+
100+
### Analysis & Metrics Tools
101+
102+
#### `get_inner_trade_data`
70103
Get company insider trading data.
71104

72-
- symbol (string): Stock code
105+
<details>
106+
<summary>Parameters</summary>
73107

74-
### `get_financial_metrics`
108+
- `symbol` (string, required): Stock code
75109

110+
</details>
111+
112+
#### `get_financial_metrics`
76113
Get key financial metrics from the three major financial statements.
77114

78-
- symbol (string): Stock code
79-
- recent_n (number, optional): Number of most recent records to return (default: 10)
115+
<details>
116+
<summary>Parameters</summary>
117+
118+
- `symbol` (string, required): Stock code
119+
- `recent_n` (number, optional): Number of most recent records to return (default: 10)
80120

81-
### `get_time_info`
121+
</details>
82122

123+
#### `get_time_info`
83124
Get current time with ISO format, timestamp, and the last trading day.
84125

85-
## Usage Instructions
126+
## Installation & Setup
86127

87128
### Running Modes
88129

@@ -93,58 +134,89 @@ The server supports two modes: stdio and streamable-http
93134
- `--host`: Host to bind to in HTTP mode (default: 0.0.0.0)
94135
- `--port`: Port to listen on in HTTP mode (default: 8081)
95136

96-
**Note:** When using streamable-http mode, the MCP server will be available at `http://{host}:{port}/mcp`. For the default configuration, this would be `http://0.0.0.0:8081/mcp`.
137+
> **Note:** When using streamable-http mode, the MCP server will be available at `http://{host}:{port}/mcp`. For the default configuration, this would be `http://0.0.0.0:8081/mcp`.
97138
98-
### Installing via Smithery
139+
### Installation Options
99140

141+
#### Option 1: Via Smithery
100142
To install akshare-one-mcp for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@zwldarren/akshare-one-mcp):
101143

102144
```bash
103145
npx -y @smithery/cli install @zwldarren/akshare-one-mcp --client claude
104146
```
105147

106-
### Installing via `uv`
107-
148+
#### Option 2: Via `uv`
108149
Install [uv](<https://docs.astral.sh/uv/getting-started/installation/>) if you haven't already.
109150

110-
Add the following configuration:
151+
Add the following configuration to your MCP Client settings:
111152

112153
```json
113-
"mcpServers": {
154+
{
155+
"mcpServers": {
114156
"akshare-one-mcp": {
115-
"command": "uvx",
116-
"args": ["akshare-one-mcp"]
157+
"command": "uvx",
158+
"args": ["akshare-one-mcp"]
117159
}
160+
}
118161
}
119162
```
120163

121-
### Installing via local source code
164+
#### Option 3: Local Development Setup
122165

123166
1. Clone this repository:
124-
125-
```bash
126-
git clone https://github.com/zwldarren/akshare-one-mcp.git
127-
cd akshare-one-mcp
128-
```
167+
```bash
168+
git clone https://github.com/zwldarren/akshare-one-mcp.git
169+
cd akshare-one-mcp
170+
```
129171

130172
2. Install dependencies:
131-
132-
```bash
133-
uv sync
134-
```
135-
136-
3. Add the following configuration:
137-
138-
```json
139-
"mcpServers": {
140-
"akshare-one-mcp": {
141-
"command": "uv",
142-
"args": [
143-
"--directory",
144-
"/path/to/akshare-one-mcp",
145-
"run",
146-
"akshare-one-mcp"
147-
]
148-
}
149-
}
150-
```
173+
```bash
174+
uv sync
175+
```
176+
177+
3. Add the following configuration to your MCP Client settings:
178+
```json
179+
{
180+
"mcpServers": {
181+
"akshare-one-mcp": {
182+
"command": "uv",
183+
"args": [
184+
"--directory",
185+
"/path/to/akshare-one-mcp",
186+
"run",
187+
"akshare-one-mcp"
188+
]
189+
}
190+
}
191+
}
192+
```
193+
194+
## Technical Indicators Reference
195+
196+
The `get_hist_data` tool supports the following technical indicators:
197+
198+
### Trend Indicators
199+
- **Moving Averages**: SMA (Simple Moving Average), EMA (Exponential Moving Average)
200+
- **Trend Tracking**: MACD (Moving Average Convergence Divergence), APO (Absolute Price Oscillator), PPO (Percentage Price Oscillator)
201+
- **Rate of Change**: ROC (Rate of Change), ROCP (Rate of Change Percentage), ROCR (Rate of Change Ratio), ROCR100
202+
- **Other**: TRIX (Triple Exponential Moving Average), ULTOSC (Ultimate Oscillator)
203+
204+
### Momentum Indicators
205+
- **Relative Strength**: RSI (Relative Strength Index), CCI (Commodity Channel Index)
206+
- **Trend Strength**: ADX (Average Directional Index), DX (Directional Index)
207+
- **Money Flow**: MFI (Money Flow Index), MOM (Momentum), CMO (Chande Momentum Oscillator), WILLR (Williams %R)
208+
209+
### Volatility Indicators
210+
- **Bollinger Bands**: BOLL (Bollinger Bands)
211+
- **Average True Range**: ATR (Average True Range)
212+
- **Parabolic SAR**: SAR (Parabolic Stop and Reverse)
213+
214+
### Volume Indicators
215+
- **Volume**: OBV (On-Balance Volume), AD (Accumulation/Distribution Line), ADOSC (Accumulation/Distribution Oscillator)
216+
217+
### Other Indicators
218+
- **Stochastic**: STOCH (Stochastic Oscillator)
219+
- **Aroon**: AROON (Aroon Indicator), AROONOSC (Aroon Oscillator)
220+
- **Balance of Power**: BOP (Balance of Power)
221+
- **Directional Indicators**: MINUS_DI, MINUS_DM, PLUS_DI, PLUS_DM
222+
- **Time Series Forecast**: TSF (Time Series Forecast)

0 commit comments

Comments
 (0)