使用说明
项目简介
CoinStats MCP服务器是一个基于Model Context Protocol (MCP) 构建的应用后端,旨在为LLM客户端提供访问CoinStats API的标准化接口。通过此服务器,LLM应用可以便捷地获取加密货币市场数据、用户的投资组合信息以及最新的加密货币新闻资讯。
主要功能点
- 加密货币市场数据访问: 提供全面的加密货币市场数据,包括价格、市值、交易量、价格变动、供应信息等。
- 投资组合跟踪: 支持通过Share Token访问CoinStats投资组合数据,包括投资组合的币种列表、图表、交易记录等。
- 加密货币新闻资讯: 提供来自CoinStats News的最新加密货币新闻,支持按类型、ID等检索。
- 工具 (Tools) 注册与执行: 预置丰富的工具,LLM客户端可以通过调用这些工具获取所需数据。例如,获取币种列表、查询特定币种信息、获取钱包余额、查询新闻等。
- 本地缓存支持: 支持Share Token本地缓存,方便跨会话使用投资组合功能。
安装步骤
- 安装 Node.js 和 npm: 确保你的系统已安装 Node.js 和 npm (Node 包管理器)。
- 获取仓库代码: 从 GitHub 克隆或下载 'coinstats-mcp' 仓库代码到本地。
- 安装依赖: 在仓库根目录下打开终端,运行以下命令安装项目依赖:
npm install - 构建项目: 运行以下命令构建项目,将 TypeScript 代码编译为 JavaScript:
npm run build - 设置 API 密钥: 从 CoinStats API Documentation 获取 API 密钥,并将其设置为环境变量 'COINSTATS_API_KEY'。例如,在终端中可以这样设置(不同操作系统设置环境变量的方式可能不同):
请将 '<YOUR_API_KEY>' 替换为你的实际 API 密钥。export COINSTATS_API_KEY=<YOUR_API_KEY> # Linux/macOS set COINSTATS_API_KEY=<YOUR_API_KEY> # Windows
服务器配置
MCP客户端需要配置服务器的启动命令才能连接到 CoinStats MCP 服务器。以下是 NPX 和 Docker 两种方式的配置示例,请根据你的 MCP 客户端配置进行选择:
NPX 配置
{ "mcpServers": { "coinstats-mcp": { "command": "npx", "args": [ "-y", "@coinstats/coinstats-mcp" ], "env": { "COINSTATS_API_KEY": "<YOUR_API_KEY>" } } } }
- 'server name': 'coinstats-mcp' (服务器名称,客户端用于标识和调用)
- 'command': 'npx' (启动命令,使用 npx 运行 npm 包)
- 'args':
- '-y': (npx 参数,自动确认安装包)
- '@coinstats/coinstats-mcp': (要执行的 npm 包,即 CoinStats MCP 服务器)
- 'env':
- 'COINSTATS_API_KEY': '<YOUR_API_KEY>' (环境变量,用于传递 CoinStats API 密钥,请替换为你的实际 API 密钥)
Docker 配置
{ "mcpServers": { "coinstats-mcp": { "command": "docker", "args": [ "run", "-i", "--rm", "-e", "COINSTATS_API_KEY", "coinstats/coinstats-mcp" ], "env": { "COINSTATS_API_KEY": "<YOUR_API_KEY>" } } } }
- 'server name': 'coinstats-mcp' (服务器名称,客户端用于标识和调用)
- 'command': 'docker' (启动命令,使用 Docker 运行容器)
- 'args':
- 'run': (docker 命令,运行一个新的容器)
- '-i': (docker 参数,保持标准输入打开)
- '--rm': (docker 参数,容器退出后自动删除)
- '-e': (docker 参数,设置环境变量)
- 'COINSTATS_API_KEY': (环境变量名称)
- 'coinstats/coinstats-mcp': (Docker 镜像名称,即 CoinStats MCP 服务器镜像)
- 'env':
- 'COINSTATS_API_KEY': '<YOUR_API_KEY>' (环境变量,用于传递 CoinStats API 密钥,请替换为你的实际 API 密钥)
基本使用方法
- 启动 MCP 服务器: 配置好 MCP 客户端后,客户端会自动启动 CoinStats MCP 服务器。服务器将在 stdio 上运行,并输出 "CoinStats MCP Server running on stdio" 表示服务器已成功启动。
- 在 LLM 应用中使用工具: 通过 MCP 客户端,你可以调用 CoinStats MCP 服务器提供的工具来获取数据。工具名称和参数定义在 'src/tools/toolConfigs.ts' 文件中。例如,你可以使用 'get-coins' 工具获取加密货币列表,使用 'get-news' 工具获取最新的加密货币新闻。
- 配置 Share Token (可选): 如果需要访问私有投资组合数据,你需要在 CoinStats Web App 上获取 Portfolio Share Token,并使用 'save-share-token' 工具将其保存到本地缓存。之后,可以使用需要 Share Token 的工具(如 'get-portfolio-coins', 'get-portfolio-chart')来访问你的投资组合数据。
注意: 使用 CoinStats MCP 服务器需要有效的 CoinStats API 密钥。请务必妥善保管你的 API 密钥。
信息
分类
网页与API