使用说明

项目简介

'rollup-plugin-mcp' 是一款 Rollup 插件,它在 Rollup 构建过程中嵌入了一个 MCP 服务器。该插件旨在为 AI 助手提供关于代码库的上下文信息,并允许 AI 助手与构建流程进行交互。通过该插件,AI 助手可以理解项目结构、构建配置和错误信息,并利用预置或自定义的工具来获取更深入的项目信息或执行特定的构建任务。

主要功能点

  • MCP 服务器集成: 在 Rollup 构建流程中创建并管理 MCP 服务器。
  • 双向 AI 集成: 不仅向 AI 助手提供关于代码库的上下文信息,还允许 AI 主动修改和控制构建过程。
  • 丰富的模块信息: 通过 Rollup 钩子暴露模块依赖、构建配置和错误诊断等信息给 AI 助手。
  • 可扩展的工具框架: 允许开发者通过简单的接口创建自定义 MCP 工具,暴露项目特定的信息或功能。
  • 构建流程集成: 无缝集成到 Rollup 插件链和 Rollup 钩子的任何阶段。
  • 持久化服务器: 在 Rollup 监听模式下保持运行,实现持续的 AI 交互。
  • 标准传输层: 使用 HTTP 和 Server-Sent Events (SSE) 实现与 MCP 协议 AI 助手的广泛兼容性。

安装步骤

pnpm add -D rollup-plugin-mcp

服务器配置

MCP 客户端需要配置以下 JSON 格式信息以连接到 Rollup MCP 服务器:

{
  "serverName": "rollup-plugin-mcp",
  "command": "rollup",
  "args": ["--config", "rollup.config.js", "--watch"]
}
  • 'serverName': MCP 服务器的名称,这里设置为 "rollup-plugin-mcp"。
  • 'command': 启动 Rollup 监听模式的命令,通常为 "rollup"。
  • 'args': 传递给 Rollup 命令的参数,包括 Rollup 配置文件路径(例如 "rollup.config.js")和启用监听模式的标志 "--watch"。

基本使用方法

  1. 在 'rollup.config.js' 中引入插件:
    import mcp from 'rollup-plugin-mcp';
    import { ModuleTool, BuildConfigTool, BuildErrorTool } from 'rollup-plugin-mcp/tools';
    
    export default {
      // ... Rollup 配置
      plugins: [
        mcp({
          provideRollupMcpTools: () => [
            new ModuleTool(),
            new BuildConfigTool(),
            new BuildErrorTool()
          ]
        }),
        // ... 其他 Rollup 插件
      ]
    };
  2. 配置插件选项 (可选): 可以根据需要配置 'McpPluginOptions' 中的选项,例如端口号、主机名等。
  3. 启动 Rollup 监听模式: 运行 'rollup --config rollup.config.js --watch' 命令启动 Rollup 构建,同时也会启动 MCP 服务器。
  4. 连接 MCP 客户端: MCP 客户端可以连接到 'http://localhost:14514/mcp/sse' (默认地址) 与服务器进行通信。

注意: MCP 服务器默认仅在 Rollup 监听模式下启动。如果需要在非监听模式下使用,请将插件选项 'useOnlyInWatchMode' 设置为 'false'。

信息

分类

开发者工具