使用说明

项目简介

MCP Finder Server 是一个实现了 Model Context Protocol (MCP) 的服务器,专注于提供 MCP 服务器的发现和管理工具。它本身不提供通用的资源或 Prompt 模板管理,而是作为 MCP 生态系统中的辅助工具,帮助用户更方便地找到并使用其他 MCP 服务器。

主要功能点

  • 发现 MCP 服务器 (find-mcp): 允许用户通过名称搜索 Smithery 平台上注册的 MCP 服务器,返回服务器的名称、描述、主页等信息。
  • 收集 MCP 服务器配置 (collect-config): 获取指定 MCP 服务器的连接配置信息,包括配置项的名称、是否必需、描述等,帮助用户了解连接该服务器所需的配置。
  • 安装 MCP 服务器 (install-mcp): 生成在本地机器上安装指定 MCP 服务器的命令,并提供不同客户端的安装选项。

安装步骤

  1. 安装 Node.js 和 npm: 确保你的机器上已安装 Node.js (v14.0.0 或更高版本) 和 npm。
  2. 克隆仓库: 将 GitHub 仓库 'mcp-finder-mcp-server' 克隆到本地。
    git clone https://github.com/bbangjooo/mcp-finder-mcp-server.git
    cd mcp-finder-mcp-server
  3. 安装依赖: 在项目根目录下运行以下命令安装项目依赖。
    npm install
  4. 配置环境变量: 在项目根目录下创建 '.env' 文件,并添加 Smithery API Key。你需要一个 Smithery API Key 才能访问 Smithery 平台的服务。
    SMITHERY_API_KEY=你的_Smithery_API_Key
  5. 构建项目: 运行构建命令编译 TypeScript 代码。
    npm run build

服务器配置

MCP Finder Server 通过标准输入输出 (stdio) 与 MCP 客户端通信。以下是 MCP 客户端连接 MCP Finder Server 的配置信息示例 (JSON 格式):

{
  "serverName": "mcp-finder",
  "command": "node",
  "args": [
    "build/index.js"
  ]
}

配置参数说明:

  • 'serverName': MCP 服务器的名称,可以自定义,例如 "mcp-finder"。
  • 'command': 启动 MCP 服务器的命令,这里是 'node',表示使用 Node.js 运行时。
  • 'args': 命令参数数组,这里指向构建后的 'index.js' 文件,即服务器的入口文件。

注意: 请确保 MCP 客户端能够找到 'node' 命令,并且相对于客户端的工作目录,'build/index.js' 的路径是正确的。

基本使用方法

  1. 启动 MCP Finder Server: 在项目根目录下运行以下命令启动服务器。

    node build/index.js

    如果启动成功,你会在控制台看到 "MCP Finder Server running on stdio" 的消息。

  2. 配置 MCP 客户端: 将上面提供的服务器配置信息添加到你的 MCP 客户端配置中,确保客户端能够连接到 stdio 传输的 MCP 服务器。

  3. 使用工具: 通过 MCP 客户端,你可以调用 MCP Finder Server 提供的工具。

    示例工具调用 (假设使用 MCP 客户端发送 JSON-RPC 请求):

    • 查找 MCP 服务器 (find-mcp):

      {
        "jsonrpc": "2.0",
        "method": "call_tool",
        "params": {
          "tool_name": "find-mcp",
          "parameters": {
            "mcpServerName": "example-server"  //  要查找的 MCP 服务器名称,例如 "example-server"
          }
        },
        "id": 1
      }

      服务器会返回包含找到的 MCP 服务器信息的 JSON 字符串。

    • 收集 MCP 服务器配置 (collect-config):

      {
        "jsonrpc": "2.0",
        "method": "call_tool",
        "params": {
          "tool_name": "collect-config",
          "parameters": {
            "qualifiedName": "@user/example-mcp-server" // MCP 服务器的 qualifiedName,例如 "@user/example-mcp-server"
          }
        },
        "id": 2
      }

      服务器会返回包含配置项信息的 JSON 字符串。

    • 安装 MCP 服务器 (install-mcp):

      {
        "jsonrpc": "2.0",
        "method": "call_tool",
        "params": {
          "tool_name": "install-mcp",
          "parameters": {
            "qualifiedName": "@user/another-mcp-server", // 要安装的 MCP 服务器 qualifiedName,例如 "@user/another-mcp-server"
            "client": "claude" //  指定客户端,例如 "claude", "cursor" 等
            // "config": { ... } //  可选的配置参数,根据服务器配置需求添加
          }
        },
        "id": 3
      }

      服务器会返回安装命令,并尝试在后台执行安装。安装结果会通过工具调用的响应返回。

    请参考仓库代码和 Smithery 平台文档,获取更详细的工具参数和使用方法。

信息

分类

开发者工具