Nostr MCP 服务器使用说明

项目简介

Nostr MCP 服务器旨在为 AI 模型提供与 Nostr 网络交互的桥梁。通过实现 Model Context Protocol (MCP),它允许 AI 模型以标准化的方式调用 Nostr 的功能,例如发布笔记和发送闪电网络 Zaps。该服务器支持 SSE 和 Stdio 两种传输模式,为 LLM 应用提供安全且可扩展的上下文服务。

主要功能点

  • 发布 Nostr 笔记 (post_note):允许 AI 模型在 Nostr 网络上发布文本消息。
  • 发送闪电网络 Zaps (send_zap):支持 AI 模型向 Nostr 用户发送闪电网络 Zaps 打赏。
  • 支持 SSE 和 Stdio 传输模式:灵活适应不同的应用场景和客户端需求。
  • MCP 协议兼容:遵循 MCP 协议标准,易于与各种 MCP 客户端集成。

安装步骤

  1. 克隆仓库

    git clone https://github.com/AbdelStark/nostr-mcp
    cd nostr-mcp
  2. 安装依赖

    npm install
  3. 配置环境变量 复制 '.env.example' 文件并重命名为 '.env',根据需要修改以下配置:

    • 'LOG_LEVEL': 日志级别,例如 'debug', 'info', 'warn', 'error'。
    • 'NODE_ENV': 运行环境,例如 'development', 'production'。
    • 'NOSTR_RELAYS': Nostr 中继服务器地址列表,用逗号分隔,例如 'wss://relay.damus.io,wss://relay.primal.net'。
    • 'NOSTR_NSEC_KEY': 你的 Nostr 私钥,以 'nsec' 开头。
    • 'SERVER_MODE': 服务器运行模式,可选 'sse' 或 'stdio'。
    • 'PORT': 当 'SERVER_MODE' 为 'sse' 时,服务器监听的端口号,默认为 '9000'。

服务器配置 (MCP 客户端)

以下 JSON 配置信息用于 MCP 客户端连接 Nostr MCP 服务器。请根据你的 '.env' 配置文件中的 'SERVER_MODE' 选择合适的配置。

若 'SERVER_MODE=stdio'

{
  "serverName": "nostr-mcp",
  "command": "node",
  "args": ["dist/cli.js"],
  "transport": "stdio"
}

若 'SERVER_MODE=sse' (假设端口为 9000)

{
  "serverName": "nostr-mcp",
  "command": "node",
  "args": ["dist/cli.js"],
  "transport": "sse",
  "port": 9000
}
  • 'serverName': 服务器名称,可自定义。
  • 'command': 启动服务器的命令,通常为 'node'。
  • 'args': 传递给启动命令的参数,指向服务器的入口文件 'dist/cli.js'。
  • 'transport': MCP 客户端与服务器通信的传输协议,'stdio' 或 'sse',需要与服务器配置一致。
  • 'port': (仅 'sse' 传输模式需要) 服务器监听的端口号,与 '.env' 文件中的 'PORT' 配置一致。

基本使用方法

  1. 启动服务器

    • 开发模式 (热重载): 'npm run dev'
    • 生产模式: 'npm start'
  2. 配置 MCP 客户端 将上述 “服务器配置 (MCP 客户端)” 中的 JSON 配置信息填入你的 MCP 客户端配置中。确保 'transport' 和 'port' 等参数与服务器实际运行模式和端口一致。

  3. 通过 MCP 客户端调用工具 使用 MCP 客户端向 Nostr MCP 服务器发送请求,调用 'post_note' 或 'send_zap' 工具,实现发布笔记或发送 Zaps 功能。具体工具参数请参考仓库 README 文档中 "Available Tools" 部分的说明。

信息

分类

通信与社交