m8-mcp-server 1.0.1 → 1.1.0

package/README.md

@@ -1,67 +1,153 @@
-# M8 移动端框架智能辅助工具 (MCP)
+# M8 MCP Server
 
-本工具是一个 Model Context Protocol (MCP) 服务，专为 Epoint M8 移动前端框架开发者设计。它允许 AI 助手直接查询 M8 UI 组件、Util 工具类、EJS 原生 API 文档，并获取内置的编码规范，从而生成符合标准的高质量代码。
+M8 移动前端跨端框架智能开发辅助工具，基于 Model Context Protocol (MCP) 协议。
 
 ## 功能特性
 
-- **文档查询**: 快速检索 M8 UI 组件 (如 `uploader`, `datepicker`) 和常用工具方法。
-- **EJS API**: 查询 EJS 容器提供的原生能力 (如 `audio`, `camera`)。
-- **规范检索**: 获取项目内置的 JS, Vue, CSS 编码规范。
+- 📚 **文档查询** - 快速搜索 EJS API、UI 组件、Util 工具文档
+- 🎯 **智能推荐** - 根据需求推荐合适的组件和方法
+- 💻 **代码生成** - 生成符合规范的 Vue、JavaScript、SCSS 代码
+- 📋 **规范检查** - 检查代码是否符合编码规范
+- 🆕 **MCP Prompts** - 内置提示词模板，自动注入编码规范
 
-## 安装
+## 安装使用
 
-无需克隆源码，支持直接通过 `npx` 使用（需先发布到 npm）：
+### 通过 npx 运行
 
 ```bash
 npx m8-mcp-server
 ```
 
-或者全局安装：
+### MCP 配置
 
-```bash
-npm install -g m8-mcp-server
-m8-mcp
-```
-
-## 配置 (Claude Desktop)
-
-在您的 `claude_desktop_config.json` 中添加以下配置：
+在 Kiro 或其他支持 MCP 的 AI 助手中配置：
 
 ```json
 {
   "mcpServers": {
-    "m8-mcp": {
+    "m8-mcp-server": {
       "command": "npx",
-      "args": ["-y", "m8-mcp-server"]
+      "args": ["m8-mcp-server"],
+      "disabled": false,
+      "autoApprove": [
+        "search_docs",
+        "get_component_info",
+        "get_api_info",
+        "get_util_info",
+        "get_coding_standard"
+      ]
     }
   }
 }
 ```
 
-## 💡 AI 提示词规范 (Prompt)
+## 可用工具
+
+| 工具名称 | 描述 |
+|---------|------|
+| `search_docs` | 搜索 M8 框架文档 |
+| `get_component_info` | 获取 UI 组件详细信息 |
+| `get_api_info` | 获取 EJS API 详细信息 |
+| `get_util_info` | 获取 Util 工具方法信息 |
+| `get_coding_standard` | 获取编码规范 |
+| `generate_code` | 生成符合规范的代码 |
+| `recommend_solution` | 智能推荐解决方案 |
+
+## MCP Prompts (v1.1.0 新增)
+
+M8 MCP Server 提供内置的 MCP Prompts，自动注入编码规范和代码模板。
+
+### 可用 Prompts
 
-为了让 AI 更好地利用此工具，请在对话开头使用以下提示词：
+| Prompt 名称 | 描述 | 参数 |
+|------------|------|------|
+| `generate_page` | 生成页面代码 | `requirement`(必需), `vueVersion`(可选) |
+| `generate_component` | 生成 Vue 组件 | `requirement`(必需), `vueVersion`(可选) |
+| `generate_form` | 生成表单页面 | `requirement`(必需), `vueVersion`(可选) |
+| `generate_list` | 生成列表页面 | `requirement`(必需), `vueVersion`(可选) |
+| `review_code` | 代码审查 | `code`(必需), `type`(可选) |
 
-```text
-你是一位精通 Epoint M8 移动端框架的开发专家。请利用 m8-mcp 工具辅助我也完成开发任务。
+### 参数说明
+
+- **requirement**: 需求描述，如 "用户登录表单"
+- **vueVersion**: Vue 版本，`2` = M8.3/Vue2，`3` = M8.4/Vue3（默认 3）
+- **code**: 需要审查的代码
+- **type**: 代码类型 `vue`/`javascript`/`scss`
+
+### 使用示例
 
-开发原则：
-1. **优先查阅文档**：在编写任何 UI 组件或调用原生 API 之前，必须先使用 `search_m8_docs` 或 `search_ejs_api` 查询相关文档，确保参数和用法正确。
-2. **遵守编码规范**：生成代码前，请检查或回忆 `get_coding_standards` 中的规范，特别是文件头注释、CSS 命名隔离等要求。
-3. **智能推荐**：如果我不确定使用哪个组件，请根据我的需求描述查询文档并推荐最合适的组件。
 ```
+// 生成 Vue3 页面
+使用 generate_page prompt:
+- requirement: "用户个人中心页面"
+- vueVersion: "3"
+
+// 生成 Vue2 表单
+使用 generate_form prompt:
+- requirement: "用户注册表单"
+- vueVersion: "2"
+
+// 代码审查
+使用 review_code prompt:
+- code: "<你的代码>"
+- type: "vue"
+```
+
+### Prompts 自动注入内容
+
+- ✅ Vue/JavaScript/SCSS 编码规范
+- ✅ 版本对应的代码模板
+- ✅ EJS API vs M8 组件选择指南
+- ✅ 全局变量使用提醒（Util、Config）
+- ✅ 根据需求关键词注入的上下文内容
 
 ## 使用示例
 
-- **查找上传组件**: 调用 `search_m8_docs("uploader")`
-- **查找音频 API**: 调用 `search_ejs_api("audio")`
-- **查看 JS 规范**: 调用 `get_coding_standards("js")`
+### 搜索文档
 
-## 发布与构建
+```
+搜索 toast 相关文档
+```
 
-本项目的源码不包含在 npm 包中，仅包含编译后的 `dist` 目录。
+### 获取组件信息
+
+```
+获取 em-button 组件的使用方法
+```
+
+### 生成代码
+
+```
+生成一个用户列表的 Vue3 组件
+```
+
+## 开发
 
 ```bash
-# 本地构建 (生成 dist 并混淆)
+# 安装依赖
+npm install
+
+# 开发模式
+npm run dev
+
+# 构建
 npm run build
+
+# 测试
+npm test
 ```
+
+## 更新日志
+
+### v1.1.0
+- 新增 MCP Prompts 功能
+- 支持 generate_page、generate_component、generate_form、generate_list、review_code 提示词
+- 自动注入编码规范和代码模板
+
+### v1.0.1
+- 初始版本
+- 文档查询、代码生成、规范检查功能
+
+## 许可证
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,449 @@
+/**
+ * MCP Server 核心实现
+ * 负责初始化 MCP 协议处理和工具注册
+ *
+ * @作者: Kiro
+ * @创建时间: 2024-12-25
+ * @描述: 提供文档查询、智能推荐、代码生成和 Prompts 服务
+ */
+/**
+ * M8 MCP Server 类
+ * 提供文档查询、智能推荐、代码生成和 Prompts 服务
+ */
+declare class M8McpServer {
+    private server;
+    private indexer;
+    private promptManager;
+    private tools;
+    private isRunning;
+    constructor();
+    /**
+     * 启动 MCP Server
+     */
+    start(): Promise<void>;
+    /**
+     * 停止 MCP Server
+     */
+    stop(): Promise<void>;
+    /**
+     * 设置请求处理器
+     */
+    private setupHandlers;
+}
+
+/**
+ * M8 MCP Server 类型定义
+ * 定义所有核心数据结构和接口
+ */
+/**
+ * 文档分类枚举
+ */
+type DocumentCategory = 'ejs-api' | 'ui-component' | 'util-tool' | 'typical-case' | 'standard';
+/**
+ * 编码规范类型
+ */
+type StandardCategory = 'css' | 'javascript' | 'vue' | 'project-structure';
+/**
+ * 文档基础模型
+ */
+interface Document {
+    /** 唯一标识符 */
+    id: string;
+    /** 文档标题 */
+    title: string;
+    /** 文档分类 */
+    category: DocumentCategory;
+    /** 文件路径 */
+    filePath: string;
+    /** 关键词 */
+    keywords: string[];
+    /** 摘要 */
+    summary: string;
+    /** 完整内容 */
+    content: string;
+    /** 最后更新时间 */
+    lastUpdated?: string;
+}
+/**
+ * 参数信息
+ */
+interface ParameterInfo {
+    /** 参数名称 */
+    name: string;
+    /** 参数类型 */
+    type: string;
+    /** 参数描述 */
+    description: string;
+    /** 是否必填 */
+    required?: boolean;
+    /** 默认值 */
+    defaultValue?: string;
+}
+/**
+ * 返回值信息
+ */
+interface ReturnInfo {
+    /** 返回类型 */
+    type: string;
+    /** 返回描述 */
+    description: string;
+}
+/**
+ * 平台支持情况
+ */
+interface PlatformSupport {
+    /** EJS H5 应用 */
+    ejsH5?: boolean;
+    /** 新点小程序 */
+    ejsMiniProgram?: boolean;
+    /** H5 */
+    h5?: boolean;
+    /** 钉钉 */
+    dingtalk?: boolean;
+    /** 微信小程序 */
+    wechat?: boolean;
+    /** 支付宝小程序 */
+    alipay?: boolean;
+}
+/**
+ * API 信息
+ */
+interface ApiInfo {
+    /** API 名称 */
+    name: string;
+    /** API 描述 */
+    description: string;
+    /** 参数列表 */
+    parameters: ParameterInfo[];
+    /** 返回值 */
+    returns?: ReturnInfo;
+    /** 平台支持情况 */
+    platformSupport?: PlatformSupport;
+    /** 使用示例 */
+    examples: string[];
+}
+/**
+ * Props 信息
+ */
+interface PropInfo {
+    /** 属性名称 */
+    name: string;
+    /** 属性类型 */
+    type: string;
+    /** 属性描述 */
+    description: string;
+    /** 默认值 */
+    defaultValue?: string;
+    /** 是否必填 */
+    required?: boolean;
+}
+/**
+ * 事件信息
+ */
+interface EventInfo {
+    /** 事件名称 */
+    name: string;
+    /** 事件描述 */
+    description: string;
+    /** 回调参数 */
+    callbackParams?: string;
+}
+/**
+ * 组件信息
+ */
+interface ComponentInfo {
+    /** 组件名称 */
+    name: string;
+    /** 组件描述 */
+    description: string;
+    /** Props 列表 */
+    props: PropInfo[];
+    /** 事件列表 */
+    events: EventInfo[];
+    /** 使用示例 */
+    examples: string[];
+}
+/**
+ * 方法信息
+ */
+interface MethodInfo {
+    /** 方法名称 */
+    name: string;
+    /** 方法描述 */
+    description: string;
+    /** 参数列表 */
+    parameters: ParameterInfo[];
+    /** 返回值 */
+    returns?: ReturnInfo;
+    /** 使用示例 */
+    examples: string[];
+    /** 平台支持 */
+    platformSupport?: PlatformSupport;
+}
+/**
+ * 规范规则
+ */
+interface StandardRule {
+    /** 规则名称 */
+    name: string;
+    /** 规则描述 */
+    description: string;
+    /** 正确示例 */
+    goodExample?: string;
+    /** 错误示例 */
+    badExample?: string;
+}
+/**
+ * 搜索选项
+ */
+interface SearchOptions {
+    /** 搜索分类过滤 */
+    category?: DocumentCategory;
+    /** 最大返回数量 */
+    limit?: number;
+    /** 模糊匹配阈值 */
+    fuzzyThreshold?: number;
+}
+/**
+ * 搜索结果
+ */
+interface SearchResult {
+    /** 文档ID */
+    id: string;
+    /** 文档标题 */
+    title: string;
+    /** 文档分类 */
+    category: DocumentCategory;
+    /** 匹配分数 */
+    score: number;
+    /** 匹配摘要 */
+    excerpt: string;
+    /** 文件路径 */
+    filePath: string;
+}
+/**
+ * 工具定义
+ */
+interface ToolDefinition {
+    /** 工具名称 */
+    name: string;
+    /** 工具描述 */
+    description: string;
+    /** 输入参数 Schema */
+    inputSchema: {
+        type: 'object';
+        properties: Record<string, unknown>;
+        required?: string[];
+    };
+}
+/**
+ * 工具调用结果
+ */
+interface ToolResult {
+    content: Array<{
+        type: 'text';
+        text: string;
+    }>;
+    isError?: boolean;
+}
+/**
+ * search_docs 工具输入
+ */
+interface SearchDocsInput {
+    /** 搜索关键词 */
+    query: string;
+    /** 文档分类过滤 */
+    category?: DocumentCategory;
+    /** 最大返回数量 */
+    limit?: number;
+}
+/**
+ * get_component_info 工具输入
+ */
+interface GetComponentInfoInput {
+    /** 组件名称 */
+    componentName: string;
+}
+/**
+ * get_api_info 工具输入
+ */
+interface GetApiInfoInput {
+    /** API 模块名称 */
+    module: string;
+    /** API 方法名称 */
+    method?: string;
+}
+/**
+ * get_util_info 工具输入
+ */
+interface GetUtilInfoInput {
+    /** Util 分类 */
+    category: string;
+    /** 方法名称 */
+    method?: string;
+}
+/**
+ * get_coding_standard 工具输入
+ */
+interface GetCodingStandardInput {
+    /** 规范类型 */
+    type: StandardCategory | 'all';
+    /** 具体规则关键词 */
+    keyword?: string;
+}
+/**
+ * generate_code 工具输入
+ */
+interface GenerateCodeInput {
+    /** 代码类型 */
+    type: 'vue-component' | 'javascript' | 'scss' | 'api-call';
+    /** 需求描述 */
+    requirement: string;
+    /** Vue 版本 */
+    vueVersion?: 2 | 3;
+    /** 使用的组件列表 */
+    components?: string[];
+}
+/**
+ * recommend_solution 工具输入
+ */
+interface RecommendSolutionInput {
+    /** 需求描述 */
+    requirement: string;
+    /** 需求类型 */
+    type?: 'ui' | 'data' | 'native' | 'general';
+}
+/**
+ * 错误码枚举
+ */
+declare enum ErrorCode {
+    INVALID_PARAMETER = "INVALID_PARAMETER",
+    MISSING_REQUIRED_FIELD = "MISSING_REQUIRED_FIELD",
+    INVALID_CATEGORY = "INVALID_CATEGORY",
+    DOCUMENT_NOT_FOUND = "DOCUMENT_NOT_FOUND",
+    COMPONENT_NOT_FOUND = "COMPONENT_NOT_FOUND",
+    API_NOT_FOUND = "API_NOT_FOUND",
+    INDEX_ERROR = "INDEX_ERROR",
+    PARSE_ERROR = "PARSE_ERROR",
+    GENERATION_ERROR = "GENERATION_ERROR"
+}
+/**
+ * 错误响应
+ */
+interface ErrorResponse {
+    /** 错误码 */
+    code: ErrorCode;
+    /** 错误消息 */
+    message: string;
+    /** 详细信息 */
+    details?: Record<string, unknown>;
+    /** 建议操作 */
+    suggestion?: string;
+}
+/**
+ * Vue 组件生成选项
+ */
+interface VueComponentOptions {
+    /** 组件名称 */
+    name: string;
+    /** 组件描述 */
+    description: string;
+    /** Vue 版本 */
+    vueVersion: 2 | 3;
+    /** 使用的 UI 组件 */
+    components?: string[];
+    /** Props 定义 */
+    props?: PropInfo[];
+    /** 是否需要状态管理 */
+    needStore?: boolean;
+}
+/**
+ * JavaScript 代码生成选项
+ */
+interface JavaScriptOptions {
+    /** 功能描述 */
+    description: string;
+    /** 是否包含 Ajax 请求 */
+    includeAjax?: boolean;
+    /** 是否使用 async/await */
+    useAsync?: boolean;
+}
+/**
+ * SCSS 代码生成选项
+ */
+interface ScssOptions {
+    /** 类名 */
+    className: string;
+    /** 样式描述 */
+    description: string;
+    /** 是否使用变量 */
+    useVariables?: boolean;
+}
+/**
+ * 推荐项
+ */
+interface RecommendationItem {
+    /** 推荐类型 */
+    type: 'component' | 'api' | 'util';
+    /** 名称 */
+    name: string;
+    /** 描述 */
+    description: string;
+    /** 推荐理由 */
+    reason: string;
+    /** 使用示例 */
+    example?: string;
+    /** 相关规范 */
+    standards?: string[];
+}
+/**
+ * 推荐结果
+ */
+interface RecommendationResult {
+    /** 推荐列表 */
+    recommendations: RecommendationItem[];
+    /** 相关编码规范 */
+    relatedStandards: string[];
+}
+/**
+ * Prompt 参数定义
+ */
+interface PromptArgument {
+    /** 参数名称 */
+    name: string;
+    /** 参数描述 */
+    description: string;
+    /** 是否必填 */
+    required: boolean;
+}
+/**
+ * Prompt 定义
+ */
+interface PromptDefinition {
+    /** Prompt 名称 */
+    name: string;
+    /** Prompt 描述 */
+    description: string;
+    /** 参数列表 */
+    arguments: PromptArgument[];
+}
+/**
+ * Prompt 消息内容
+ */
+interface PromptMessageContent {
+    /** 内容类型 */
+    type: 'text';
+    /** 文本内容 */
+    text: string;
+}
+/**
+ * Prompt 消息
+ */
+interface PromptMessage {
+    /** 角色 */
+    role: 'user' | 'assistant';
+    /** 消息内容 */
+    content: PromptMessageContent;
+}
+
+export { type ApiInfo, type ComponentInfo, type Document, type DocumentCategory, ErrorCode, type ErrorResponse, type EventInfo, type GenerateCodeInput, type GetApiInfoInput, type GetCodingStandardInput, type GetComponentInfoInput, type GetUtilInfoInput, type JavaScriptOptions, M8McpServer, type MethodInfo, type ParameterInfo, type PlatformSupport, type PromptArgument, type PromptDefinition, type PromptMessage, type PromptMessageContent, type PropInfo, type RecommendSolutionInput, type RecommendationItem, type RecommendationResult, type ReturnInfo, type ScssOptions, type SearchDocsInput, type SearchOptions, type SearchResult, type StandardCategory, type StandardRule, type ToolDefinition, type ToolResult, type VueComponentOptions };