使用说明

项目简介

本项目是一个基于 Model Context Protocol (MCP) 的服务器实现,旨在为大型语言模型 (LLM) 提供从去中心化社交网络 Nostr 中检索代码片段的功能。通过注册 'fetchNostrSnippets' 工具,LLM 客户端可以调用此服务器来获取最新的 Nostr 代码片段,从而扩展 LLM 的知识库和上下文感知能力。

主要功能点

  • 检索 Nostr 代码片段: 通过 'fetchNostrSnippets' 工具,可以从 Nostr 网络检索指定数量的代码片段(类型为 kind 1337 的事件)。
  • 可配置的检索数量: 工具支持 'limit' 参数,允许客户端指定每次检索的代码片段数量。
  • 标准 MCP 服务器: 遵循 MCP 协议,易于与支持 MCP 协议的 LLM 客户端集成。
  • 使用 Stdio 传输协议: 采用标准输入输出 (Stdio) 作为服务器与客户端之间的通信方式,简化部署和配置。

安装步骤

  1. 克隆仓库: 首先,将仓库克隆到本地:
    git clone https://github.com/nodetec/nostr-code-snippet-mcp
    cd nostr-code-snippet-mcp
  2. 安装依赖: 确保已安装 Node.js 和 npm,然后在仓库目录下运行命令安装项目依赖:
    npm install

服务器配置

要将此 MCP 服务器配置到 MCP 客户端(例如 Claude),您需要在客户端的配置文件中添加 MCP 服务器的描述信息。以下是 Claude 客户端的配置示例 (通常位于 'claude_desktop_config.json' 文件中):

{
  "mcpServers": {
    "nostr-snippets": {  //  服务器名称,客户端使用此名称来调用工具,可以自定义
      "command": "node",  //  启动服务器的命令,这里使用 Node.js 运行 index.js 文件
      "args": ["/path/to/nostr-code-snippet-mcp/index.js"] //  命令参数,指向 index.js 文件的绝对路径。请将 "/path/to/nostr-code-snippet-mcp" 替换为仓库在您本地的实际路径
    }
  }
}

注意: 请将 '"/path/to/nostr-code-snippet-mcp"' 替换为您克隆的 'nostr-code-snippet-mcp' 仓库在您计算机上的绝对路径。'"nostr-snippets"' 是您为该服务器定义的名称,客户端将使用此名称来调用服务器提供的工具。

基本使用方法

配置完成后,在支持 MCP 协议的 LLM 客户端中,您可以使用 '@服务器名称 工具名称 [参数]' 的格式来调用 'fetchNostrSnippets' 工具。例如,在 Claude 中,如果您在配置中将服务器命名为 '"nostr-snippets"',则可以使用以下命令来检索代码片段:

@nostr-snippets fetchNostrSnippets limit=5

这条命令指示客户端调用名为 '"nostr-snippets"' 的 MCP 服务器,并执行 'fetchNostrSnippets' 工具,同时设置 'limit' 参数为 '5',表示检索 5 个代码片段。服务器将返回包含检索到的代码片段的 JSON 响应。

您可以在 LLM 客户端中根据需要调整 'limit' 参数来控制每次检索的代码片段数量。

信息

分类

开发者工具