Modes MCP Server 使用说明

项目简介

Modes MCP Server 是一个实现了 Model Context Protocol (MCP) 协议的服务器,专注于管理自定义的操作模式。它允许客户端通过 MCP 协议动态配置和管理应用的操作模式,例如创建新的模式、查询模式详情、更新或删除现有模式,以及验证模式配置的有效性。

主要功能点

  • 自定义模式管理: 提供对自定义操作模式的完整 CRUD (创建、读取、更新、删除) 操作。
  • 模式配置验证: 使用 Zod 进行模式配置的 schema 验证,确保配置的正确性。
  • 配置文件监听: 监控模式配置文件变化,支持热更新(尽管当前版本可能仅输出日志)。
  • 错误处理: 采用标准的 MCP 错误代码进行错误 reporting。
  • 原子文件操作: 保证模式配置文件操作的原子性,避免数据损坏。

安装步骤

  1. 克隆仓库:
    git clone https://github.com/ccc0168/modes-mcp-server.git
    cd modes-mcp-server
  2. 安装依赖:
    npm install
  3. 构建项目:
    npm run build

服务器配置 (MCP Client Settings)

要将 Modes MCP Server 集成到 MCP 客户端,您需要在客户端的 MCP 设置文件中添加以下服务器配置。请根据您的实际环境修改路径。

{
  "mcpServers": {
    "modes": {  // 服务器名称,客户端用于引用
      "command": "node",  // 启动服务器的命令,这里使用 node 解释器
      "args": ["/path/to/modes-mcp-server/build/index.js"], // 启动命令的参数,指向构建后的服务器入口文件 index.js。请替换为实际路径
      "env": { // 环境变量
        "MODES_CONFIG_PATH": "/path/to/custom/modes.json" // 模式配置文件的路径。请替换为您自定义的模式配置文件的实际路径
      },
      "disabled": false, // 是否禁用该服务器,false 表示启用
      "alwaysAllow": []  // 总是允许的工具列表,默认为空数组
    }
  }
}

配置参数说明:

  • 'server name': 服务器名称,例如 "modes",客户端使用此名称来标识和调用该服务器提供的工具。
  • 'command': 启动服务器的命令,通常是 Node.js 的 'node' 命令。
  • 'args': 命令参数,指向服务器入口文件 'index.js' 的路径。请务必将 '/path/to/modes-mcp-server/build/index.js' 替换为构建后 'index.js' 文件在您系统中的绝对路径。
  • 'env': 环境变量配置。
    • 'MODES_CONFIG_PATH': 请务必将 '/path/to/custom/modes.json' 替换为您自定义的模式配置文件的绝对路径。 该路径指向存储自定义模式配置的 JSON 文件。
  • 'disabled': 设置为 'false' 以启用该服务器。
  • 'alwaysAllow': 一个工具名称数组,客户端可以无需用户授权直接调用这些工具。默认为空。

重要提示:

  • 请根据您的实际安装路径和自定义模式配置文件的位置,修改 'args' 和 'env.MODES_CONFIG_PATH' 中的路径。
  • 确保 Node.js 环境已正确安装,并且 'node' 命令在您的系统 PATH 环境变量中可用。

基本使用方法

  1. 启动服务器: Modes MCP Server 在配置完成后,通常由 MCP 客户端在需要时自动启动。您无需手动运行服务器,客户端会根据您在 MCP 设置中提供的 'command' 和 'args' 启动服务器进程。

  2. 配置自定义模式: 编辑您在 'MODES_CONFIG_PATH' 环境变量中指定的 JSON 配置文件(默认为 '%APPDATA%/Code/User/globalStorage/rooveterinaryinc.roo-cline/settings/cline_custom_modes.json'),按照 'examples/modes.example.json' 中的格式添加、修改或删除自定义模式。

  3. 使用 MCP 客户端调用工具: 客户端可以通过 MCP 协议调用 Modes MCP Server 提供的工具来管理模式。可用的工具包括:

    • 'list_modes': 列出所有已配置的自定义模式。
    • 'get_mode': 获取指定 slug 的模式详情。
    • 'create_mode': 创建新的自定义模式。
    • 'update_mode': 更新已存在的自定义模式。
    • 'delete_mode': 删除指定 slug 的模式。
    • 'validate_mode': 验证模式配置是否有效。

    具体的工具调用方法取决于您使用的 MCP 客户端的接口和文档。通常,您需要构造符合 MCP 协议的 JSON-RPC 请求,并发送给客户端,客户端会负责与 Modes MCP Server 通信。

示例工具调用 (假设使用 'list_modes' 工具):

客户端会发送类似以下的 JSON-RPC 请求给 Modes MCP Server:

{
  "jsonrpc": "2.0",
  "method": "call_tool",
  "params": {
    "server_name": "modes", // 指定服务器名称
    "tool_name": "list_modes", // 工具名称
    "arguments": {} // 工具参数,list_modes 工具不需要参数
  },
  "id": 1
}

服务器会返回包含模式列表的 JSON-RPC 响应。

请参考 MCP 协议文档和您使用的 MCP 客户端的文档,了解更详细的工具调用和使用方法。

信息

分类

开发者工具