使用说明
测试MCP服务器
一个模块化的Node.js服务器,公开OKX加密货币市场数据(价格、烛台、, 等)和业务分析工具(销售、按地区划分的收入等)作为模型上下文协议(MCP) 工具。
特性
- MCP工具服务器: 将OKX市场数据和业务分析作为MCP工具公开。
- 加密货币数据:
- 获取任何OKX工具的最新价格、买入价、卖出价、24小时高点/低点和交易量。
- 检索任何OKX仪器和区间的历史烛台数据。
- 业务分析:
- 获得总销售收入。
- 获取按地区分组的销售总额。
- 比较各地区的销售业绩。
项目结构
src/
api/ # Handles OKX and business analytics API requests
handlers/ # MCP tool handler logic
server/ # Server setup and logic
types/ # TypeScript interfaces for APIs
main.ts # Entry point, starts the server
入门指南
先决条件
- Node.js(建议使用v18+)
- npm、pnpm或yarn
- OKX公共API(公共终结点不需要密钥)
安装
npm install
# or
pnpm install
# or
yarn install
构建
npm run build
# or
pnpm run build
# or
yarn build
跑
npm start
# or
pnpm start
# or
yarn start
用法
该服务器作为MCP工具服务器在stdio上运行。它公开了以下工具:
加密货币市场数据工具
1. get_price
获取给定OKX工具的最新价格和市场数据。
输入:
{
"instrument": "BTC-USDT"
}
输出:
{
"instrument": "BTC-USDT",
"lastPrice": "104417.4",
"bid": "104417.9",
"ask": "104418",
"high24h": "104528",
"low24h": "102613.9",
"volume24h": "3294.9269693",
"timestamp": "2025-05-18T13:45:24.914Z"
}
2. get_candlesticks
获取给定OKX仪器和区间的历史烛台数据。
输入:
{
"instrument": "BTC-USDT",
"bar": "1D",
"limit": 2
}
输出: 一组烛台对象,包括打开、高、低、关闭、音量和时间戳。
业务分析工具
3. get_total_revenue
获取总销售收入。
输出:
{
"totalRevenue": 1234.56
}
4. get_sales_by_region
获取特定地区的销售总额。
输入:
{
"region": "North"
}
输出:
{
"region": "North",
"revenue": 120.5
}
5.区域销售比较
您可以比较不同地区的销售额,以确定表现最佳的地区。
发展
- API层: 所有OKX和业务分析API调用都在
src/api/. - 处理人员: MCP工具逻辑处于
src/handlers/. - 类型: API响应类型在
src/types/. - 服务器: MCP服务器设置已完成
src/server/. - 入口点: 使用启动服务器
src/main.ts.
贡献
- 分叉回购
- 创建功能分支(
git checkout -b feature/YourFeature) - 提交您的更改(
git commit -am 'Add some feature') - 推到分支(
git push origin feature/YourFeature) - 打开拉取请求
许可证
国际协调委员会
作者
- 吉什努·萨蒂什(KIMP)