Satellaite MCP Server 使用说明

项目简介

Satellaite MCP Server 是一个基于 Model Context Protocol (MCP) 标准构建的服务器，旨在为大型语言模型（LLM）客户端提供访问 Satellaite API 的桥梁。它允许 LLM 通过标准化的 MCP 协议，安全、可扩展地获取链上资源信息和调用链上合约工具，从而增强 LLM 在去中心化应用领域的应用能力。

主要功能点

资源管理: 提供对 Satellaite 链上 Relay（合约）信息的访问，包括 Relay 列表和单个 Relay 详情。LLM 客户端可以通过预定义的 URI 访问这些资源，获取 JSON 格式的数据。
工具注册与执行: 注册了 'get_relays' 和 'call_relay' 两个工具，允许 LLM 客户端获取 Relay 列表和调用指定的 Relay 合约。工具执行结果以 JSON 格式返回给客户端。
标准 MCP 协议: 完全实现了 Model Context Protocol 规范，确保与任何兼容 MCP 协议的 LLM 客户端无缝对接。
易于部署: 提供可执行的二进制文件，并支持使用 'npx' 快速部署和运行。
使用 Stdio 传输: 默认使用标准输入输出 (Stdio) 作为 MCP 服务器与客户端的通信协议，简化部署和集成。

安装步骤

由于该仓库发布了 npm 包，推荐使用 'npx' 直接运行，无需本地安装：

安装 Node.js 和 npm: 确保你的环境中已安装 Node.js 和 npm (Node Package Manager)。
配置 API_BASE_URL 环境变量: Satellaite MCP Server 需要知道 Satellaite API 的基础 URL 才能正常工作。你需要设置 'API_BASE_URL' 环境变量，指向你的 Satellaite API 服务地址。例如，如果你的 API 服务运行在 'http://localhost:8080/api'，则需要设置 'API_BASE_URL=http://localhost:8080/api'。

服务器配置

对于 MCP 客户端（例如 Claude Desktop），你需要配置 MCP 服务器的启动信息。以下是针对 Satellaite MCP Server 的 'claude_desktop_config.json' 配置示例：

{
  "mcpServers": {
    "satellaite": {  // 服务器名称，可以自定义
      "command": "npx",  // 启动命令，使用 npx 运行 npm 包
      "args": [  // 命令参数
        "-y",  // 自动确认 npx 安装包
        "@satellaite/mcp-server" // 要运行的 npm 包名称
      ],
      "env": {  // 环境变量
        "API_BASE_URL": "<API_BASE_URL>"  // Satellaite API 的基础 URL，请替换为实际地址，例如 "http://localhost:8080/api"
      }
    }
  }
}

请务必将 '<API_BASE_URL>' 替换为你实际的 Satellaite API 服务地址。

基本使用方法

启动 MCP 服务器: 配置好 'claude_desktop_config.json' 后，当 Claude Desktop 等 MCP 客户端启动时，会自动根据配置启动 Satellaite MCP Server。
客户端请求资源: LLM 客户端可以使用以下 URI 请求 Satellaite Relay 资源：
- 'relays://list': 获取所有 Relay 列表。
- 'relays://{relayId}': 获取指定 'relayId' 的 Relay 详情，例如 'relays://relay123'。
客户端调用工具: LLM 客户端可以调用以下工具：
- 'get_relays': 获取所有 Relay 列表。
- 'call_relay': 调用指定的 Relay 合约，需要提供 'relayId' 参数。

客户端会通过 MCP 协议与 Satellaite MCP Server 进行通信，服务器会处理请求并返回 JSON 格式的响应数据。

关键词