关键词

Cursor规则Playbooks API规则管理代码上下文LLM工具

项目简介

Cursor Rules MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器，它将 Playbooks Rules API 的功能以 MCP 工具的形式暴露出来，使得 LLM 客户端可以通过标准化的 MCP 协议访问和使用 Cursor 规则。该服务器允许 LLM 应用程序列出、搜索和获取 Cursor 规则，从而为代码生成、编辑等任务提供上下文信息。

主要功能点

  • 列出规则 (listCursorRules): 获取 Playbooks Rules API 中所有可用的规则列表。
  • 搜索规则 (searchCursorRules): 根据关键词查询相关的 Cursor 规则。
  • 获取规则 (getCursorRule): 根据规则的 slug 或 URL 获取具体的 Cursor 规则内容，并将其转换为 Cursor 编辑器可识别的规则文件格式（.cursor/rules/*.mdc）。

安装步骤

  1. 安装 npm 包: 如果你的机器上没有 Node.js 和 npm，请先安装。然后运行以下命令全局安装 'playbooks-rules' 包： 
    npm install -g playbooks-rules

服务器配置

MCP 客户端需要配置以下 JSON 信息以连接到 Cursor Rules MCP 服务器。请注意，这里的 'command' 和 'args' 是客户端用来启动 MCP 服务器进程的指令。

{
  "serverName": "Cursor Rules MCP",  // MCP 服务器的名称，用于客户端识别
  "command": "playbooks-rules",      // 启动 MCP 服务器的命令，这里假设 playbooks-rules 命令已全局安装
  "args": [],                         // 启动命令的参数，此服务器不需要额外参数
  "transport": "stdio",               // 使用标准的 stdio 传输协议
  "capabilities": [                   // 服务器声明提供的能力（工具等）
    "tools"
  ]
}

配置说明:

  • '"serverName"': 服务器的名称，客户端会显示这个名称。
  • '"command"': 客户端执行的命令，用于启动 'playbooks-rules' MCP 服务器。全局安装后，可以直接使用 'playbooks-rules' 命令。
  • '"args"': 传递给启动命令的参数，这里不需要任何参数，所以为空数组 '[]'。
  • '"transport"': 指定 MCP 客户端和服务器之间通信的传输协议，这里使用 'stdio'，即标准输入输出。
  • '"capabilities"': 声明服务器提供的功能，'"tools"' 表示此服务器提供工具调用功能。

基本使用方法

  1. 启动 MCP 服务器: 在安装 'playbooks-rules' 后，MCP 客户端会根据上述配置自动启动 'playbooks-rules' 命令，从而启动 Cursor Rules MCP 服务器。

  2. 客户端调用工具: LLM 客户端可以使用以下工具与服务器交互。以下是工具调用示例（JSON-RPC 请求格式，通常由 MCP 客户端库自动处理）：

    • 列出规则 (listCursorRules):

      {
  "jsonrpc": "2.0",
  "method": "tool/execute",
  "params": {
    "tool_name": "listCursorRules",
    "arguments": {}
  },
  "id": 1
}

      服务器会返回所有可用规则的列表。

    • 搜索规则 (searchCursorRules):

      {
  "jsonrpc": "2.0",
  "method": "tool/execute",
  "params": {
    "tool_name": "searchCursorRules",
    "arguments": {
      "query": "正则表达式"  // 替换为你想要搜索的关键词
    }
  },
  "id": 2
}

      服务器会返回搜索结果，即匹配查询关键词的规则列表。

    • 获取规则 (getCursorRule):

      {
  "jsonrpc": "2.0",
  "method": "tool/execute",
  "params": {
    "tool_name": "getCursorRule",
    "arguments": {
      "slug": "rule-slug-or-url" // 替换为规则的 slug 或 URL
    }
  },
  "id": 3
}

      服务器会返回指定规则的内容，并以 JSON 字符串形式返回 Cursor 规则文件内容。

注意: 用户通常不需要手动构建 JSON-RPC 请求。MCP 客户端库会提供更友好的 API 来调用这些工具。上述 JSON 示例仅用于说明服务器提供的工具及其参数。

信息

分类

开发者工具

访问项目