MCP Server for Shioaji
A Model Context Protocol (MCP) server that provides AI assistants with access to Shioaji trading API for the Taiwanese financial market.
Overview
This server implements the MCP protocol to expose Shioaji API functionality as tools that can be used by AI assistants. It allows AI models to:
- Retrieve current stock prices
- Fetch historical data
- List available stocks
- And more...
Installation
Prerequisites
- Python 3.10 or higher
- uv (fast Python package manager)
Using uv
uv sync
Configuration
Before running the server, you need to configure your Shioaji API credentials. There are two ways to do this:
Environment Variables
Set the following environment variables:
export SHIOAJI_API_KEY="your_api_key"
export SHIOAJI_SECRET_KEY="your_secret_key"
Using .env File
Create a .env file in the root directory with the following content:
SHIOAJI_API_KEY=your_api_key
SHIOAJI_SECRET_KEY=your_secret_key
Running the Server
Start the server with:
uv run mcp-server-shioaji
The server will start on http://0.0.0.0:8000 by default.
Available Tools
The server exposes the following tools via MCP:
get_stock_price
Get the current price of a stock by its symbol.
{
"tool": "get_stock_price",
"params": {
"symbols": "TW.2330,TW.2317"
}
}
Response will include price information for the requested stocks, including open, high, low, close prices, volume, and other trading data.
get_kbars
Fetch K-Bar (candlestick) data for a stock within a date range.
{
"tool": "get_kbars",
"params": {
"symbol": "TW.2330",
"start_date": "2023-12-01",
"end_date": "2023-12-15"
}
}
If start_date is not provided, it defaults to today. If end_date is not provided, it defaults to the same as start_date.
scan_stocks
Scan stocks based on various ranking criteria.
{
"tool": "scan_stocks",
"params": {
"scanner_type": "VolumeRank",
"ascending": false,
"limit": 10
}
}
Supported scanner types:
VolumeRank- Ranking by trading volumeAmountRank- Ranking by trading amountTickCountRank- Ranking by number of transactionsChangePercentRank- Ranking by percentage changeChangePriceRank- Ranking by price changeDayRangeRank- Ranking by daily range
Default limit is 20, and results are sorted in descending order by default (set ascending to true for ascending order).
Development
Project Structure
mcp-server-shioaji/
├── src/
│ └── mcp_server_shioaji/
│ ├── __init__.py # Package entry point
│ └── server.py # MCP server implementation
├── pyproject.toml # Project metadata and dependencies
└── README.md # This file
Adding New Tools
To add new Shioaji functionality, modify server.py and add new tool definitions using the @mcp.tool decorator.
License
MIT
Acknowledgements
Metadata
Release files for iflow-mcp_mcp-server-shioaji 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| iflow_mcp_mcp_server_shioaji-0.1.0.tar.gz | 58.7 kB | Without provenance | Details for iflow_mcp_mcp_server_shioaji-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| iflow_mcp_mcp_server_shioaji-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for iflow_mcp_mcp_server_shioaji-0.1.0-py3-none-any.whl |
Total release size: 64.6 kB
Release files / iflow_mcp_mcp_server_shioaji-0.1.0.tar.gz
| Download URL | iflow_mcp_mcp_server_shioaji-0.1.0.tar.gz |
|---|---|
| Size | 58.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
167c140b4cad30ea04e39a49089836aa3bb5c0648249908abd9a6b3452d6795b
|
|
BLAKE2b-256 checksum How to use checksums |
a532aedca4ae7f598a8df0815be1a137b2e6a15cefb9472ca2d0277721b84c9a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.9.8
|
Release files / iflow_mcp_mcp_server_shioaji-0.1.0-py3-none-any.whl
| Download URL | iflow_mcp_mcp_server_shioaji-0.1.0-py3-none-any.whl |
|---|---|
| Size | 5.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bbaaf173654223134da3bc2a19054bd7c6c0ee5fcf8e0985c4bc9ba185e4a847
|
|
BLAKE2b-256 checksum How to use checksums |
59c7d76c7858a016664536b860a0b4a86a0e469948e775e81a9f00aa277579a9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.9.8
|
Security for iflow-mcp_mcp-server-shioaji 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.