article
README
🚀 xtquantai
xtquantai 是一个基于模型上下文协议(MCP)的服务器,它将迅投(xtquant)量化交易平台的功能与人工智能助手相结合,让 AI 能够直接访问和操作量化交易数据与功能,为量化交易领域带来更智能、便捷的操作体验。
✨ 主要特性
XTQuantAI 提供以下核心功能(陆续更新中,欢迎提交新创意):
基础数据查询
- 获取交易日期 (
get_trading_dates) - 获取指定市场的交易日期 - 获取板块股票列表 (
get_stock_list) - 获取特定板块的股票列表 - 获取股票详情 (
get_instrument_detail) - 获取股票的详细信息
行情数据
- 获取历史行情数据 (
get_history_market_data) - 获取股票的历史行情数据 - 获取实时行情数据 (
get_realtime_market_data) - 获取股票的实时行情数据 - 订阅行情更新 (
subscribe_market_updates) - 订阅并接收实时行情更新
图表与可视化
- 生成价格图表 (
generate_price_chart) - 通过传入时间范围和参数,生成指定股票的价格图表 - 技术指标分析 (
technical_indicator_analysis) - 计算并返回股票的技术指标(如移动平均线、相对强弱指数等)
📦 安装指南
前提条件
- Python 3.11 或更高版本
- 安装 QMT 或投研终端
- 安装 uv 包管理工具
下载与安装
git clone https://github.com/your-repository/xtquantai.git
cd xtquantai
pip install -r requirements.txt
💻 使用示例
在 Cursor 中集成 MCP 服务器(仅限 Windows 环境)
方法一:通过 main.py 启动
在项目根目录中运行以下命令:
python main.py
方法二:直接通过 Python 脚本运行
运行 server_direct.py 文件:
python server_direct.py
工具使用示例
基础用法
# 获取交易日期
from xtquantai import get_trading_dates
dates = get_trading_dates(start_date="2023-01-01", end_date="2023-12-31")
print(dates)
高级用法
# 获取板块股票列表
from xtquantai import get_stock_list_by_sector
sector_stocks = get_stock_list_by_sector(sector_id="Technology")
print(sector_stocks)
# 生成价格图表
from xtquantai import generate_price_chart
generate_price_chart(stock_code="AAPL", start_date="2023-01-01", end_date="2023-12-31", save_path="chart.png")
📚 详细文档
启动服务器
python src/xtquantai/server.py
使用 MCP Inspector 进行调试(仅用于开发)
安装 Node.js 环境后,运行以下命令:
npx @modelcontextprotocol/inspector uv run xtquantai
构建与发布
-
同步依赖并更新锁文件:
uv sync -
构建包分发:
uv build -
发布到 PyPI:
uv publish
调试
由于 MCP 服务器通过标准输入/输出运行,调试具有挑战性。我们强烈推荐使用 MCP Inspector 进行调试。
项目结构
xtquantai/
├── src/
│ └── xtquantai/
│ ├── __init__.py # 包初始化文件
│ └── server.py # MCP 服务器实现
├── main.py # 启动脚本
├── server_direct.py # 直接 HTTP 服务器实现
├── pyproject.toml # 项目配置
└── README.md # 项目文档
📄 许可证
本项目采用 MIT 许可证 - 详见 LICENSE 文件。
贡献
欢迎贡献!请随时提交问题或拉取请求。
扫码加入微信群