项目简介

NWC MCP Server 是一个 MCP (Model Context Protocol) 服务器,它允许大型语言模型 (LLM) 通过 Nostr Wallet Connect (NWC) 协议连接到比特币闪电网络钱包。这使得 LLM 能够安全地访问闪电网络钱包的功能,例如查询余额、创建发票和支付发票。

主要功能点

  • 连接闪电网络钱包: 通过 Nostr Wallet Connect (NWC) 协议与用户的闪电网络钱包建立连接。
  • 获取钱包信息: 允许 LLM 获取连接钱包的基本信息和功能。
  • 查询余额: 允许 LLM 查询连接钱包的闪电币余额。
  • 创建闪电发票: 允许 LLM 代表用户创建闪电网络发票以收款。
  • 支付闪电发票: 允许 LLM 代表用户支付闪电网络发票。
  • 查询发票详情: 允许 LLM 查询闪电网络发票的详细信息。

安装步骤

  1. 安装 Node.js 和 Yarn: 确保你的系统已安装 Node.js (20+) 和 Yarn。
  2. 克隆仓库: 从 GitHub 克隆 'nwc-mcp-server' 仓库到本地。
    git clone https://github.com/getAlby/nwc-mcp-server.git
    cd nwc-mcp-server
  3. 安装依赖: 使用 Yarn 安装项目依赖。
    yarn install
  4. 构建项目: 构建项目代码。
    yarn build
  5. 配置 NWC 连接字符串: 复制 '.env.example' 文件为 '.env',并编辑 '.env' 文件,将 'NWC_CONNECTION_STRING' 替换为你的 NWC 连接字符串。你可以从支持 NWC 的闪电网络钱包中获取连接字符串。

服务器配置

要将 NWC MCP Server 添加到 MCP 客户端(例如 Claude Desktop, Goose, Cline),你需要配置 MCP 服务器的启动命令和参数。以下是配置示例 (JSON 格式):

{
  "mcpServers": {
    "nwc": {  // 服务器名称,可以自定义
      "command": "npx", // 启动命令,这里使用 npx 运行 npm 包
      "args": ["-y", "@getalby/nwc-mcp-server"], // 命令参数,-y 表示自动确认安装 npm 包
      "env": {
        "NWC_CONNECTION_STRING": "YOUR NWC CONNECTION STRING HERE" // 环境变量,NWC 连接字符串需要配置在这里,实际使用时请替换为你的连接字符串
      }
    }
  }
}

注意: 请将 '"YOUR NWC CONNECTION STRING HERE"' 替换为你实际的 NWC 连接字符串。这个连接字符串需要从你的闪电网络钱包获取,并确保钱包支持 Nostr Wallet Connect (NWC)。

基本使用方法

  1. 启动服务器: 在仓库根目录下,运行以下命令启动 NWC MCP Server。

    yarn inspect

    或者直接运行:

    yarn start

    服务器将通过 Stdio 协议与 MCP 客户端通信。

  2. 在 MCP 客户端中配置并连接服务器: 根据你的 MCP 客户端(例如 Claude Desktop, Goose, Cline)的文档,配置并添加上面提供的服务器配置信息。客户端将自动连接到 NWC MCP Server。

  3. 使用 LLM 调用工具: 在 LLM 中,你可以指示它使用 NWC MCP Server 提供的工具,例如 'get_balance', 'make_invoice', 'pay_invoice' 等,来与你的闪电网络钱包进行交互。具体的工具名称和使用方式请参考工具的描述信息。

信息

分类

商业系统