m8-mcp-server 1.0.1 → 1.1.0

package/dist/index.d.ts

@@ -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 };