使用说明

项目简介

本项目 'mcp-template' 是一个基于 Model Context Protocol (MCP) 的服务器示例，它演示了如何使用 MCP 协议构建一个应用后端，向 LLM 客户端提供上下文信息和功能。该模板集成了多种实用工具和资源，展示了 MCP 服务器在实际应用中的潜力。

主要功能点

资源 (Resources):
- '/info': 提供服务器构建时间等基本信息。
- 'greeting://{name}': 提供个性化问候语。
工具 (Tools):
- 'get-coin-market': 获取 CoinGecko 上的加密货币市场行情数据。
- 'get-coin-price': 获取指定加密货币的实时价格。
- 'telegram-notice': 发送 Telegram 通知消息。
- 'get-sui-address': 获取 Sui 区块链地址。
- 'get-sui-balance': 获取 Sui 区块链余额。
- 'transfer-sui': 在 Sui 区块链上进行 SUI 代币转账。
- 'open-the-door': 一个简单的密码验证工具，用于模拟权限控制。

安装步骤

安装 Node.js 和 npm: 确保你的系统已安装 Node.js 和 npm (Node Package Manager)。

使用 npx 安装: 打开终端，运行以下命令即可安装并运行此 MCP 服务器：

npx -y git+https://github.com/v1xingyue/mcp-template.git

或者，你也可以先克隆仓库到本地再安装：

git clone https://github.com/v1xingyue/mcp-template.git
cd mcp-template
npm install
npm run build

启动服务器:
- Stdio 模式 (默认): 在终端中运行 'node dist/mcp.js stdio' 即可启动 Stdio 传输协议的 MCP 服务器。
- SSE 模式: 在终端中运行 'node dist/mcp.js sse' 即可启动 SSE (Server-Sent Events) 传输协议的 MCP 服务器。启动后，访问 'http://localhost:3001/sse' (默认端口) 即可建立 SSE 连接。

服务器配置 (MCP 客户端配置)

MCP 客户端需要以下 JSON 配置信息才能连接到此 MCP 服务器。请根据你选择的启动方式配置客户端：

使用 npx 启动 (推荐):

{
  "serverName": "mcp-template",
  "command": "npx",
  "args": ["-y", "git+https://github.com/v1xingyue/mcp-template.git"],
  "env": {
    "PROXY": "http://localhost:7890", // (可选) 代理配置，如果需要通过代理访问网络，请设置代理地址
    "COINGECKO_TOKEN": "", // CoinGecko API Token，用于获取加密货币价格，请访问 CoinGecko 开发者平台获取
    "TELEGRAM_BOT_TOKEN": "", // Telegram Bot Token，用于发送 Telegram 通知，请在 Telegram 中创建 Bot 并获取 Token
    "TELEGRAM_CHAT_ID": "",  // Telegram Chat ID，用于接收 Telegram 通知，请提供接收通知的 Telegram 用户或群组的 Chat ID
    "SUI_PRIVATE_KEY": ""   // Sui 私钥，用于 Sui 链交互功能，请谨慎配置私钥，并确保环境安全
  }
}

本地启动 (Stdio 模式):

{
  "serverName": "mcp-template",
  "command": "node",
  "args": ["dist/mcp.js", "stdio"],
  "cwd": "/path/to/mcp-template",  // 请替换为你的 mcp-template 项目本地路径
  "env": {
    "PROXY": "http://localhost:7890", // (可选) 代理配置
    "COINGECKO_TOKEN": "",
    "TELEGRAM_BOT_TOKEN": "",
    "TELEGRAM_CHAT_ID": "",
    "SUI_PRIVATE_KEY": ""
  }
}

本地启动 (SSE 模式):

{
  "serverName": "mcp-template-sse",
  "command": "node",
  "args": ["dist/mcp.js", "sse"],
  "cwd": "/path/to/mcp-template",  // 请替换为你的 mcp-template 项目本地路径
  "transport": {
    "type": "sse",
    "url": "http://localhost:3001/sse", // SSE 服务器地址，默认为 http://localhost:3001/sse
    "messagePath": "/messages" // SSE 消息接收路径，默认为 /messages
  },
  "env": {
    "PROXY": "http://localhost:7890", // (可选) 代理配置
    "COINGECKO_TOKEN": "",
    "TELEGRAM_BOT_TOKEN": "",
    "TELEGRAM_CHAT_ID": "",
    "SUI_PRIVATE_KEY": ""
  }
}

注意:

请务必根据你的实际需求配置 'env' 中的环境变量，例如 API Token、Telegram Bot 相关信息、Sui 私钥等。
'cwd' 字段需要替换为你的 'mcp-template' 项目在本地的实际路径。
SSE 模式需要配置 'transport' 字段，指定传输类型和服务器地址。

基本使用方法

连接 MCP 服务器: 在 MCP 客户端中配置上述 JSON 信息，连接到启动的 MCP 服务器。
探索资源 (Resources): 客户端可以请求服务器提供的资源，例如：
- 请求 '/info' 资源以获取服务器信息。
- 请求 'greeting://Alice' 资源以获取对 Alice 的问候语。
调用工具 (Tools): 客户端可以调用服务器注册的工具来执行特定功能，例如：
- 调用 'get-coin-price' 工具并传入 'coinId' 参数 (如 "bitcoin") 来获取比特币价格。
- 调用 'telegram-notice' 工具并传入 'message' 参数来发送 Telegram 通知。
- 调用 'get-sui-balance' 工具来查询 Sui 余额。
- 调用 'transfer-sui' 工具并传入 'to' (目标地址) 和 'amount' 参数来进行 SUI 转账。
- 调用 'open-the-door' 工具并传入 'pass' 参数 ("123456") 进行密码验证。

示例工具调用 (JSON-RPC request):

获取比特币价格:

{
  "jsonrpc": "2.0",
  "method": "tool_call",
  "params": {
    "tool_name": "get-coin-price",
    "arguments": {
      "coinId": "bitcoin"
    }
  },
  "id": "1"
}

发送 Telegram 通知:

{
  "jsonrpc": "2.0",
  "method": "tool_call",
  "params": {
    "tool_name": "telegram-notice",
    "arguments": {
      "message": "Hello from MCP Server!"
    }
  },
  "id": "2"
}

请参考 MCP 协议文档和客户端工具的使用说明，更深入地了解如何与此 MCP 服务器进行交互。

关键词