使用说明

项目简介

MCP安装器服务器是一个基于Model Context Protocol (MCP) 的应用后端,但其核心功能并非直接为LLM应用提供资源或Prompt模板,而是专注于 MCP服务器的安装和管理。它提供了一系列工具,帮助用户查找可用的MCP服务器、收集连接配置信息,以及自动化安装MCP服务器到本地环境,从而简化了LLM客户端与MCP服务器集成的复杂性。

主要功能点

  • 查找MCP服务器 (find_mcp): 允许用户通过名称在Smithery Registry中搜索已注册的MCP服务器,方便用户发现和选择合适的MCP服务器。
  • 收集配置信息 (collect_config): 针对特定的MCP服务器,收集其连接所需的配置信息,例如需要哪些配置项、是否必填以及配置项的描述,帮助用户准备正确的配置。
  • 安装MCP服务器 (install_mcp): 根据提供的MCP服务器信息和客户端类型,自动生成并执行安装命令,将指定的MCP服务器配置到目标LLM客户端(目前支持Cursor和Claude),实现一键安装。

安装步骤

  1. 安装Node.js和npm: 确保您的系统已安装Node.js (v14.0.0或更高版本) 和 npm。
  2. 安装MCP安装器服务器: 使用npm安装 '@bbangjo/mcp-installer' 包:
    npm install @bbangjo/mcp-installer

服务器配置

MCP服务器本身无需复杂配置,它作为一个工具服务器运行,主要提供工具供MCP客户端调用。对于需要连接此MCP服务器的客户端(例如Cursor或Claude),需要配置以下信息到客户端的MCP服务器列表中。

以Cursor客户端为例,配置信息通常位于 '~/.cursor/mcp.json' (macOS/Linux) 或 '%APPDATA%\Cursor\mcp.json' (Windows)。在 'mcpServers' 字段中添加以下配置:

{
  "mcpServers": {
    "mcp-installer": {  //  服务器名称,客户端内唯一标识,可自定义
      "command": "npx",  //  运行命令,通常为 npx 或 node
      "args": [          //  命令参数
        "@bbangjo/mcp-installer" //  要执行的npm包名,即本MCP服务器
      ],
      "env": {           //  环境变量
        "SMITHERY_API_KEY": "<your-smithery-api-key>" // Smithery API Key,用于访问Smithery Registry,请替换为您的API Key
      }
    }
    // ... 其他MCP服务器配置 ...
  }
}

配置参数说明:

  • 'mcp-installer': 服务器名称,用于在客户端中唯一标识此MCP服务器,可以自定义,例如 'mcp-installer-server'。
  • 'command': 运行命令,通常设置为 'npx' 以运行npm包,或者如果您全局安装了 '@bbangjo/mcp-installer',也可以使用 'node' 并指定 'index.js' 的路径。
  • 'args': 命令参数,这里指定要运行的npm包名称 '@bbangjo/mcp-installer'。
  • 'env': 环境变量,用于传递运行服务器所需的敏感信息,例如 'SMITHERY_API_KEY',需要替换为您的 Smithery API Key,用于访问Smithery Registry服务。

基本使用方法

  1. 启动MCP安装器服务器: 在配置客户端后,当客户端尝试连接到 'mcp-installer' 服务器时,会自动通过 'npx @bbangjo/mcp-installer' 命令启动服务器。您也可以在项目根目录下,执行 'npm run build' 和 'node build/index.js' 手动启动服务器进行测试。服务器启动成功后,会在控制台输出 'MCP Registry Server running on stdio'。

  2. 在LLM客户端中使用工具: 在支持MCP协议的LLM客户端中 (例如Cursor或Claude),您可以通过自然语言指令调用MCP安装器服务器提供的工具。例如,在Cursor中,您可以:

    • 查找MCP服务器: '@tool find_mcp mcpServerName=文档助手' (查找名称包含 "文档助手" 的MCP服务器)
    • 收集配置信息: '@tool collect_config qualifiedName=@smithery/文档助手-mcp-server' (收集 qualifiedName 为 '@smithery/文档助手-mcp-server' 的MCP服务器的配置信息)
    • 安装MCP服务器: '@tool install_mcp qualifiedName=@smithery/文档助手-mcp-server client=cursor' (安装 qualifiedName 为 '@smithery/文档助手-mcp-server' 的MCP服务器到 Cursor 客户端)
    • 带配置安装MCP服务器: '@tool install_mcp qualifiedName=@smithery/文档助手-mcp-server client=cursor config={"apiKey": "your_api_key"}' (安装并配置API Key)

注意:

  • 'SMITHERY_API_KEY' 是访问 Smithery Registry 所必需的,请务必在配置中正确设置。
  • 'qualifiedName' 是MCP服务器在 Smithery Registry 中的唯一标识,用于精确指定要操作的服务器。
  • 'client' 参数指定了要配置的目标客户端类型,目前支持 'cursor' 和 'claude'。
  • 'config' 参数 (可选) 允许在安装时传递配置信息给MCP服务器,配置格式需要符合目标MCP服务器的配置Schema。

信息

分类

开发者工具