使用说明

项目简介

spike-symbol-mcp-server 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在为大型语言模型 (LLM) 应用提供访问 Symbol 区块链数据的能力。它通过 MCP 协议标准化的接口，向 LLM 客户端暴露了查询账户信息和马赛克信息的工具，使得 LLM 能够便捷地获取链上数据并用于知识检索、智能合约交互等应用场景。

主要功能点

账户信息查询工具 (getAccountInfo): 允许 LLM 根据账户 ID 查询 Symbol 区块链上的账户详细信息，包括地址、公钥、余额、重要性等。
马赛克信息查询工具 (getMosaicInfo): 允许 LLM 根据马赛克 ID 查询 Symbol 区块链上的马赛克定义信息，包括所有者、供应量、分红率等。
标准 MCP 协议支持: 采用 JSON-RPC over Stdio 通信，符合 MCP 服务器规范，易于与支持 MCP 协议的 LLM 客户端集成。

安装步骤

克隆仓库:

git clone https://github.com/husqvaluna/spike-symbol-mcp-server.git
cd spike-symbol-mcp-server

安装依赖: 确保已安装 Node.js 和 npm (或 yarn)。在项目根目录下运行：
```
npm install
```

服务器配置

MCP 服务器需要配置到 MCP 客户端中才能使用。以下是 Claude Desktop 等 MCP 客户端的服务器配置示例 (JSON 格式)：

{
  "mcpServers": {
    "symbol": {  // 服务器名称，客户端内唯一标识即可
      "command": "npx", // 启动命令，这里使用 npx 执行 tsx
      "args": [      // 命令参数
        "-y",        // npx 参数，自动安装 tsx
        "tsx",       // 使用 tsx 运行 TypeScript 代码
        "/path/to/spike-symbol-mcp-server/src/index.ts" //  指向服务器入口文件 index.ts 的绝对路径，请替换为实际路径
      ]
    }
  }
}

配置参数说明:

'"symbol"': 服务器名称，可以自定义，用于在客户端中引用。
'"command": "npx"': 指定执行命令为 'npx'，用于运行 Node.js 包。
'"args": [...]': 命令参数数组，包含以下参数：
- '"-y"': 'npx' 的参数，如果 'tsx' 未安装，则自动安装。
- '"tsx"': 用于运行 TypeScript 代码的工具，确保项目中已安装 'tsx'。
- '"/path/to/spike-symbol-mcp-server/src/index.ts"': 请务必替换为 'spike-symbol-mcp-server' 仓库中 'src/index.ts' 文件的实际绝对路径。 这是 MCP 服务器的入口文件。

注意:

'/path/to/spike-symbol-mcp-server' 需要替换为你的 'spike-symbol-mcp-server' 仓库在本地文件系统中的绝对路径。
请确保你的 MCP 客户端支持 Stdio 传输协议。
服务器默认使用 stdio 作为传输协议，无需额外配置。

基本使用方法

启动 MCP 服务器: 在 'spike-symbol-mcp-server' 仓库根目录下，在终端中运行以下命令启动服务器：
```
npx tsx src/index.ts
```
如果一切正常，终端会输出 'Symbol RPC Tools running on stdio'，表示服务器已在 stdio 上运行。
在 LLM 客户端中使用工具:
- 配置好 MCP 服务器后，在支持 MCP 协议的 LLM 客户端中，应该能够发现并调用 'getAccountInfo' 和 'getMosaicInfo' 这两个工具。
- 根据 LLM 客户端的具体使用方式，输入相应的参数 (accountId 或 mosaicId) 即可调用工具查询 Symbol 区块链数据。
- 查询结果将以 JSON 格式返回，并在 LLM 客户端中展示或用于后续处理。

例如，在支持工具调用的 LLM 应用中，你可以指示 LLM 使用 'getAccountInfo' 工具查询账户地址为 '你的账户地址' 的信息。

请使用 getAccountInfo 工具查询账户地址为 你的账户地址 的信息

LLM 客户端会将此请求转换为 MCP 调用，发送给 'spike-symbol-mcp-server' 服务器，服务器执行查询并将结果返回给 LLM 客户端。

关键词