README
🚀 XTBApiServer
XTBApiServer 是一个借助 @sharplygroup/xtb-api-js 库来暴露 XTB API 的 MCP 服务器。它支持通过模型上下文协议与您的 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(任意)
- 参数:
- getSymbolInfoPrompt:获取特定工具的信息。
警告
⚠️ 重要提示
此 MCP 服务器作为一个示例提供,使用时请自担风险。在将此服务器用于实账户之前,请确保您理解 XTB API 及其潜在风险。
Scan to contact