该项目实现了用于CoinGlass API(v4)的模型上下文协议(MCP)服务器。它允许兼容MCP的客户端(如AI助手、IDE扩展或自定义应用程序)访问期货市场分析,例如持仓量、清算、多空比和资金费率。
该服务器暴露了以下MCP客户端可以调用的工具:
COINGLASS_OPEN_INTEREST:某个符号的交易所持仓量列表;可选历史数据
COINGLASS_LIQUIDATIONS_PAIR:历史对清算(v4 /api/futures/liquidation/history)
COINGLASS_LIQUIDATIONS_COIN:聚合币种清算(v4 /api/futures/liquidation/aggregated-history)
COINGLASS_LONG_SHORT_RATIO:全球账户多空比快照
COINGLASS_FUNDING_RATE:跨交易所当前资金费率
COINGLASS_HYPERLIQUID_WHALE_ALERT:实时Hyperliquid鲸鱼警报(>100万美元)
参数:prettyFormat?(布尔值,默认:true)
COINGLASS_HYPERLIQUID_WHALE_POSITION:实时Hyperliquid鲸鱼仓位(>100万美元)
参数:prettyFormat?(布尔值,默认:true)
工具调用响应始终返回成功代码,即使在API错误的情况下也是如此。在错误情况下,工具响应包括原始API响应。
有几种方法可以运行mcp-coinglass:
无需全局安装即可直接运行发布的包。请参见下面的MCP客户端配置示例。
pnpm add -g mcp-coinglass
pnpm install
pnpm run build
pnpm run start
# 在项目根目录运行,
pnpm run build
npx @modelcontextprotocol/inspector node dist/index.js
此服务器需要一个CoinGlass API密钥。所有CoinGlass v4端点都需要CG-API-KEY头。从您的账户仪表板生成API密钥,并通过环境变量提供。参考:
创建一个.env文件(或在您的MCP客户端中配置环境变量):
COINGLASS_API_KEY=your_api_key_here
包含一个.env.sample文件作为参考;复制到.env并填写您的密钥。
注意:所有可用工具都需要升级的CoinGlass API计划才能工作
MCP客户端(助手、IDE扩展)将此服务器作为后台进程运行。配置您的客户端,使其具有类似于以下内容的服务器条目。
使用pnpm dlx:
{
"mcpServers": {
"coinglass-mcp-server": {
"command": "pnpm",
"args": ["dlx", "mcp-coinglass"],
"env": {
"COINGLASS_API_KEY": "your_api_key_here"
}
}
}
}
如果已全局安装(pnpm add -g mcp-coinglass):
{
"mcpServers": {
"coinglass-mcp-server": {
"command": "mcp-coinglass",
"args": [],
"env": {
"COINGLASS_API_KEY": "your_api_key_here"
}
}
}
}
MCP客户端向工具传递JSON参数。示例如下:
{ "tool": "COINGLASS_OPEN_INTEREST", "params": { "symbol": "BTC", "includeHistory": true, "period": "24h" } }
{ "tool": "COINGLASS_LIQUIDATIONS", "params": { "symbol": "BTCUSDT", "timeframe": "4h" } }
{ "tool": "COINGLASS_LIQUIDATIONS_PAIR", "params": { "exchange": "Binance", "symbol": "BTCUSDT", "interval": "4h" } }
{ "tool": "COINGLASS_LIQUIDATIONS_COIN", "params": { "exchange_list": "Binance,OKX,Bybit", "symbol": "BTC", "interval": "1d" } }
{ "tool": "COINGLASS_LONG_SHORT_RATIO", "params": { "symbol": "ETH", "period": "1h" } }
{ "tool": "COINGLASS_FUNDING_RATE", "params": { "symbol": "SOL" } }
{ "tool": "COINGLASS_HYPERLIQUID_WHALE_ALERT", "params": {} }
{ "tool": "COINGLASS_HYPERLIQUID_WHALE_POSITION", "params": {} }
这些是默认格式化的输出。将prettyFormat设为false以接收原始API形状的响应。
BTCUSDT的资金费率:
平均:0.0100% | 下次资金费率时间:2024-08-06T08:00:00.000Z
交易所数量:12
{
"averageRate": 0.0001,
"nextFundingTime": 1722960000000,
"exchanges": [
{ "exchange": "Binance", "rate": -0.0000335, "predictedRate": -0.00002, "nextFundingTime": 1722960000000 }
// ...
]
}
BTCUSDT的持仓量:
总持仓量(全部):$123456789
24小时变化:2.34%
{
"exchangeList": [ /* ... */ ],
"history": { /* 当includeHistory=true时可选 */ }
}
BTCUSDT的清算(对)[48个点]:
最新:多头$1.23M | 空头$2.34M
总计:多头$56.78M | 空头$67.89M
{
"latest": { /* 最新数据点 */ },
"totals": { "long": 56780000, "short": 67890000 },
"points": [ /* ... */ ]
}
BTC的清算(币种聚合)[48个点]:
最新:多头$1.23M | 空头$2.34M
总计:多头$56.78M | 空头$67.89M
{
"latest": { /* 最新数据点 */ },
"totals": { "long": 56780000, "short": 67890000 },
"points": [ /* ... */ ]
}
BTCUSDT的多空比:
多头:73.24% | 空头:26.76% | 比率:2.74
{
"latest": { /* 最新数据点 */ },
"points": [ /* ... */ ]
}
Hyperliquid鲸鱼警报:8个事件
按仓位价值排名前5:
{
"top": [
{ "user": "0xabc...", "symbol": "BTC", "positionValueUsd": 2936421.48, "positionAction": 2, "createTime": 1745219477000 }
// ...
],
"events": [ /* ... */ ]
}
Hyperliquid鲸鱼仓位:6个仓位(按价值排名前5)
{
"top": [
{ "user": "0xdef...", "symbol": "ETH", "positionSize": -44727.13, "positionValueUsd": 73589542.55, "leverage": 25, "unrealizedPnl": 27033236.42, "marginMode": "cross", "updateTime": 1745219966000 }
// ...
],
"positions": [ /* ... */ ]
}
此服务器调用了以下REST端点:
参考官方文档获取认证和速率限制信息: