本项目“ai-rules-builder”主要是一个用于构建AI编程规范(Markdown格式规则)的Web应用。其核心特色之一是包含一个 MCP服务器组件,该组件专门用于通过 Model Context Protocol (MCP) 将这些规则编程化地提供给兼容的AI客户端或编辑器(如Cursor)。
项目简介
“ai-rules-builder”帮助开发者创建和管理适用于各种技术栈的AI规则集。其内置的MCP服务器是一个部署为Cloudflare Worker的独立服务,它作为AI客户端与规则数据之间的桥梁,使得AI能够动态获取相关的开发规范作为上下文。
主要功能点
- 规则检索: 允许AI客户端查询服务器可用的规则库标识符。
- 规则内容获取: 允许AI客户端根据标识符获取特定规则库的详细规则内容(Markdown格式)。
- 标准协议通信: 通过JSON-RPC over HTTP或SSE等标准MCP传输协议与客户端交互。
安装步骤
MCP服务器作为Cloudflare Worker部署。客户端不需要本地安装此服务器代码。
- 核心项目代码: 克隆整个'ai-rules-builder'仓库。
- 依赖安装: 在项目根目录运行 'npm install' 安装前端和MCP服务器组件的依赖。
- MCP服务器部署: MCP服务器位于 './mcp-server' 目录下,设计为Cloudflare Worker。需要按照Cloudflare Worker的标准流程进行构建和部署。具体部署步骤请参考Cloudflare官方文档和 './mcp-server' 目录下的项目特定说明(如果在仓库中提供的话)。
服务器配置 (供MCP客户端参考)
MCP客户端(如某些IDE插件)需要配置连接到已部署的MCP服务器。由于这是一个远程服务(Cloudflare Worker),客户端通常通过URL连接,而不是启动本地进程。
以下是MCP客户端配置中可能需要的信息(具体的JSON结构取决于客户端实现,此处提供关键信息):
- 服务器名称: MCP Rules Server
- 连接类型: HTTP 或 SSE (取决于客户端支持和服务器端暴露的端点)
- 服务器地址 (URL): 已部署的Cloudflare Worker的URL,例如 'https://your-worker-name.your-account.workers.dev/mcp' (针对JSON-RPC over HTTP) 或 'https://your-worker-name.your-account.workers.dev/sse' (针对SSE)。
一个示例的MCP客户端配置片段可能如下所示(请注意:这不是可执行的代码,仅为客户端配置的JSON结构示例):
{ "server name": "MCP Rules Server", "connection": { "transport": "http", // 或 "sse", "websocket" (如果worker支持) "url": "https://your-worker-name.your-account.workers.dev/mcp" // 根据实际部署的URL修改 }, "description": "Provides coding rules from 10xRules.ai via MCP." // 其他可能的配置参数,如 capabilities 声明等 }
- 'server name': 服务器的标识名称。
- 'connection': 定义如何连接到服务器。
- 'transport': 使用的传输协议(例如 http, sse, websocket)。
- 'url': 服务器的访问地址。
基本使用方法
AI客户端通过MCP协议向服务器发送JSON-RPC请求:
- 发现规则库: AI客户端可以调用服务器暴露的 'listAvailableRules' 工具来获取可用的规则库标识符列表及其所属的技术栈类别。
- 获取规则内容: AI客户端根据获取到的规则库标识符(例如 'REACT_CODING_STANDARDS'),调用 'getRuleContent' 工具,并传入标识符作为参数,以获取该规则库对应的详细编程规范内容。
AI助手可以将这些获取到的规则作为额外的上下文,用于代码生成、代码审查、提供建议等任务。
信息
分类
开发者工具