Effect Patterns MCP Server

使用说明（简要概览，便于快速上手）

• 项目简介

  • 本仓库实现了基于 MCP 的服务端框架，为 LLM 客户端提供可访问的上下文资源、工具执行能力和提示模板渲染能力，帮助将应用数据和能力以标准化的方式暴露给 AI 模型使用。
  • 服务以 Next.js/Node 为基础，提供一组 REST 风格的接口入口来演示 MCP 的核心能力：资源读取、工具执行、模式信息获取与渲染等。

• 主要功能点

  • 健康与路由中间件：提供健康检查、API 版本头、基本安全头等中间件支持。
  • 模式资源与检索：支持按关键字、类别、难度等条件检索模式，以及按 ID 获取模式详情。
  • 代码分析与生成：提供分析代码、生成片段、以及模式驱动的代码生成接口。
  • 代码审阅与规则：提供代码审阅、规则列表等分析服务的入口。
  • 数据库迁移与加载：提供数据导入/导出、模式数据的批量导入等工具。
  • 安全与治理：通过路由守卫、管理员端点、环境变量校验等机制实现基本的安全控制。
  • 测试与示例：包含多组 Vitest 测试配置，覆盖主体服务、模式呈现、工具集成的验证。

• 安装步骤

  • 在本地克隆或下载代码后，进入仓库根目录。
  • 安装依赖（推荐使用 Bun）：bun install
  • 启动服务器（开发环境，示例命令可能随实际环境调整）：
    • 在本地运行：bun run dev（如项目中未自带的脚本，请按实际包管理器和启动脚本执行相应命令）
  • 服务器启动后，默认监听端口（如 3000），通过 http://localhost:3000 即可访问 API。

• 服务器配置（给 MCP 客户端的启动配置，JSON 表示，字段含义如下）

  • serverName: Effect Patterns MCP Server
  • command: bun
  • args: ["run", "dev"] 说明：启动 MCP 服务器的主命令及参数（实际请以你们的运行脚本为准，如有自定义启动命令请替换）
  • env（可选，示例用途）:
    • DATABASE_URL: 数据库连接字符串（本地或测试数据库）
    • PATTERN_API_KEY: 访问密钥（如本地开发可为空以开启开放测试模式）
    • EFFECT_PATTERNS_API_URL: MCP 服务对外暴露的入口 URL（默认 http://localhost:3000）
  • 注释：以上环境变量用于演示 MCP 客户端如何配置连接，实际开启客户端时请按你的部署环境提供相应的变量。

• 基本使用方法（简化流程）

  • 启动后，MCP 客户端可通过配置好的 serverName、command、args 读取 MCP 服务端提供的功能入口。
  • MCP 功能示例：通过客户实现的工具链向 MCP 服务请求模式检索、模式详情、代码分析/生成等，服务端返回结构化结果用于后续的对话上下文拼接或直接呈现。
  • 如需扩展能力，可在服务端实现中添加更多工具、资源类型和模板渲染逻辑，确保输出符合 MCP 规范的 JSON-RPC 风格或其它前端约定。