README
🚀 XTBApiServer
这是一个使用 @sharplygroup/xtb-api-js 库暴露XTB API的MCP服务器。它能让您通过Model Context Protocol与XTB交易账户进行交互,方便快捷地开展交易相关操作。
🚀 快速开始
先决条件
- Node.js(版本16或更高)
- npm
- 一个XTB交易账户
安装
- 克隆此仓库:
git clone [repository_url]
- 切换到项目目录:
cd xtb-mcp-server
- 安装依赖项:
npm install
配置
- 在项目目录中创建一个
.env文件,并添加您的XTB API凭证:
DEMO_ACCOUNT=true
USER_ID=your_user_id
PASSWORD=your_password
⚠️ 重要提示
请用您的实际XTB API凭证替换
your_user_id和your_password。如果您使用的是实时账户,请将DEMO_ACCOUNT设置为false。
运行服务器
- 构建TypeScript代码:
npm run build
- 运行服务器:
node build/index.js
与MCP客户端连接
您可以使用任何MCP客户端(如MCP Inspector)与此服务器连接。
- 全局安装MCP Inspector:
npm install -g @modelcontextprotocol/inspector
- 使用您的服务器运行MCP Inspector:
npx @modelcontextprotocol/inspector node build/index.js
- 在MCP Inspector UI中选择“stdio”作为传输类型并点击“连接”。
✨ 主要特性
此MCP服务器暴露了以下工具,涵盖账户操作、计算操作、市场数据操作和提示等多个方面,为您的交易操作提供全面支持。
账户操作
- getCurrentUserData:返回有关账户货币和账户杠杆的信息。
- getMarginLevel:返回各种账户指标。
计算操作
- getCommissionDef:计算佣金和汇率。
- 参数:
symbol(字符串),volume(数字)
- 参数:
- getMarginTrade:根据给定的工具和数量,返回预期的保证金。
- 参数:
symbol(字符串),volume(数字)
- 参数:
- getProfitCalculation:根据给定的交易数据计算估计利润。
- 参数:
closePrice(数字),cmd(数字),openPrice(数字),symbol(字符串),volume(数字)
- 参数:
市场数据操作
- getCalendar:返回市场事件日历。
- getChartLastRequest:返回从开始日期到当前时间的图表信息。
- 参数:
info(任何)
- 参数:
- getChartRangeRequest:返回指定时间段内的图表信息。
- 参数:
info(任何)
- 参数:
- getOHLCV:获取给定工具的开盘价、最高价、最低价和收盘价数据。
- 参数:
symbol(字符串),start(数字),end(数字)
- 参数:
提示
- getSymbolInfoPrompt:获取特定工具的信息。
- 参数:
symbol(字符串)
- 参数:
Scan to join WeChat group