mcp-probe-kit 3.0.24 → 3.1.0

package/build/resources/tool-params-guide.d.ts

@@ -0,0 +1,571 @@
+/**
+ * 工具参数指南 Resource
+ * 为 AI 提供详细的参数说明和使用示例
+ */
+export declare function getToolParamsGuide(version: string): {
+    guide: string;
+    version: string;
+    important_notes: string[];
+    best_practices: {
+        "1. \u76F4\u63A5\u4F20\u53C2": string;
+        "2. \u81EA\u7136\u8BED\u8A00": string;
+        "3. \u6700\u5C0F\u5316": string;
+        "4. \u63CF\u8FF0\u4F18\u5148": string;
+    };
+    tools: {
+        detect_shell: {
+            description: string;
+            params: {
+                input: string;
+            };
+            examples: {
+                input: string;
+            }[];
+        };
+        init_setting: {
+            description: string;
+            params: {
+                input: string;
+            };
+            examples: {
+                input: string;
+            }[];
+        };
+        init_project: {
+            description: string;
+            params: {
+                input: string;
+            };
+            examples: {
+                input: string;
+            }[];
+        };
+        gencommit: {
+            description: string;
+            params: {
+                changes: string;
+                type: string;
+            };
+            examples: ({
+                changes: string;
+                type?: undefined;
+            } | {
+                changes: string;
+                type: string;
+            })[];
+        };
+        genchangelog: {
+            description: string;
+            params: {
+                version: string;
+                from: string;
+                to: string;
+            };
+            examples: ({
+                version: string;
+                from?: undefined;
+                input?: undefined;
+            } | {
+                version: string;
+                from: string;
+                input?: undefined;
+            } | {
+                input: string;
+                version?: undefined;
+                from?: undefined;
+            })[];
+        };
+        genpr: {
+            description: string;
+            params: {
+                input: string;
+            };
+            examples: {
+                input: string;
+            }[];
+        };
+        resolve_conflict: {
+            description: string;
+            params: {
+                input: string;
+            };
+            examples: {
+                input: string;
+            }[];
+        };
+        debug: {
+            description: string;
+            params: {
+                error: string;
+                context: string;
+            };
+            examples: ({
+                error: string;
+                input?: undefined;
+                context?: undefined;
+            } | {
+                input: string;
+                error?: undefined;
+                context?: undefined;
+            } | {
+                error: string;
+                context: string;
+                input?: undefined;
+            })[];
+        };
+        code_review: {
+            description: string;
+            params: {
+                code: string;
+                focus: string;
+            };
+            examples: ({
+                code: string;
+                input?: undefined;
+                focus?: undefined;
+            } | {
+                input: string;
+                code?: undefined;
+                focus?: undefined;
+            } | {
+                code: string;
+                focus: string;
+                input?: undefined;
+            })[];
+        };
+        explain: {
+            description: string;
+            params: {
+                code: string;
+                context: string;
+            };
+            examples: ({
+                code: string;
+                input?: undefined;
+            } | {
+                input: string;
+                code?: undefined;
+            })[];
+        };
+        perf: {
+            description: string;
+            params: {
+                code: string;
+                type: string;
+            };
+            examples: ({
+                code: string;
+                input?: undefined;
+            } | {
+                input: string;
+                code?: undefined;
+            })[];
+        };
+        security_scan: {
+            description: string;
+            params: {
+                code: string;
+                scan_type: string;
+            };
+            examples: ({
+                code: string;
+                input?: undefined;
+            } | {
+                input: string;
+                code?: undefined;
+            })[];
+        };
+        refactor: {
+            description: string;
+            params: {
+                code: string;
+                goal: string;
+            };
+            examples: ({
+                code: string;
+                input?: undefined;
+            } | {
+                input: string;
+                code?: undefined;
+            })[];
+        };
+        fix: {
+            description: string;
+            params: {
+                code: string;
+                type: string;
+            };
+            examples: ({
+                code: string;
+                input?: undefined;
+            } | {
+                input: string;
+                code?: undefined;
+            })[];
+        };
+        fix_bug: {
+            description: string;
+            params: {
+                error_message: string;
+                stack_trace: string;
+            };
+            examples: ({
+                error_message: string;
+                input?: undefined;
+            } | {
+                input: string;
+                error_message?: undefined;
+            })[];
+        };
+        gentest: {
+            description: string;
+            params: {
+                code: string;
+                framework: string;
+            };
+            examples: ({
+                code: string;
+                input?: undefined;
+                framework?: undefined;
+            } | {
+                input: string;
+                code?: undefined;
+                framework?: undefined;
+            } | {
+                code: string;
+                framework: string;
+                input?: undefined;
+            })[];
+        };
+        gendoc: {
+            description: string;
+            params: {
+                code: string;
+                style: string;
+                lang: string;
+            };
+            examples: ({
+                code: string;
+                input?: undefined;
+            } | {
+                input: string;
+                code?: undefined;
+            })[];
+        };
+        genapi: {
+            description: string;
+            params: {
+                code: string;
+                format: string;
+            };
+            examples: ({
+                code: string;
+                input?: undefined;
+            } | {
+                input: string;
+                code?: undefined;
+            })[];
+        };
+        genui: {
+            description: string;
+            params: {
+                description: string;
+                framework: string;
+            };
+            examples: ({
+                description: string;
+                framework?: undefined;
+            } | {
+                description: string;
+                framework: string;
+            })[];
+        };
+        gensql: {
+            description: string;
+            params: {
+                description: string;
+                dialect: string;
+            };
+            examples: {
+                description: string;
+            }[];
+        };
+        gen_mock: {
+            description: string;
+            params: {
+                schema: string;
+                count: string;
+                format: string;
+                locale: string;
+            };
+            examples: ({
+                schema: string;
+                input?: undefined;
+                count?: undefined;
+            } | {
+                input: string;
+                count: number;
+                schema?: undefined;
+            })[];
+        };
+        design2code: {
+            description: string;
+            params: {
+                input: string;
+                framework: string;
+                style_solution: string;
+                component_type: string;
+            };
+            examples: {
+                input: string;
+            }[];
+        };
+        genreadme: {
+            description: string;
+            params: {
+                project_info: string;
+                style: string;
+            };
+            examples: ({
+                input: string;
+                project_info?: undefined;
+            } | {
+                project_info: string;
+                input?: undefined;
+            })[];
+        };
+        check_deps: {
+            description: string;
+            params: {
+                input: string;
+            };
+            examples: {
+                input: string;
+            }[];
+        };
+        convert: {
+            description: string;
+            params: {
+                code: string;
+                from: string;
+                to: string;
+            };
+            examples: ({
+                code: string;
+                to: string;
+                input?: undefined;
+            } | {
+                input: string;
+                code?: undefined;
+                to?: undefined;
+            })[];
+        };
+        css_order: {
+            description: string;
+            params: {
+                input: string;
+            };
+            examples: {
+                input: string;
+            }[];
+        };
+        split: {
+            description: string;
+            params: {
+                file: string;
+                strategy: string;
+            };
+            examples: ({
+                file: string;
+                input?: undefined;
+            } | {
+                input: string;
+                file?: undefined;
+            })[];
+        };
+        analyze_project: {
+            description: string;
+            params: {
+                project_path: string;
+                max_depth: string;
+            };
+            examples: ({
+                input: string;
+                project_path?: undefined;
+            } | {
+                project_path: string;
+                input?: undefined;
+            })[];
+        };
+        init_project_context: {
+            description: string;
+            params: {
+                docs_dir: string;
+            };
+            examples: ({
+                input: string;
+                docs_dir?: undefined;
+            } | {
+                docs_dir: string;
+                input?: undefined;
+            })[];
+        };
+        add_feature: {
+            description: string;
+            params: {
+                description: string;
+                feature_name: string;
+                docs_dir: string;
+            };
+            examples: ({
+                description: string;
+                feature_name?: undefined;
+            } | {
+                feature_name: string;
+                description: string;
+            })[];
+            important: string;
+        };
+        estimate: {
+            description: string;
+            params: {
+                task_description: string;
+                code_context: string;
+                team_size: string;
+                experience_level: string;
+            };
+            examples: ({
+                task_description: string;
+                input?: undefined;
+            } | {
+                input: string;
+                task_description?: undefined;
+            })[];
+        };
+        start_feature: {
+            description: string;
+            params: {
+                description: string;
+                feature_name: string;
+                docs_dir: string;
+            };
+            examples: {
+                description: string;
+            }[];
+        };
+        start_bugfix: {
+            description: string;
+            params: {
+                error_message: string;
+                stack_trace: string;
+            };
+            examples: ({
+                error_message: string;
+                input?: undefined;
+            } | {
+                input: string;
+                error_message?: undefined;
+            })[];
+        };
+        start_review: {
+            description: string;
+            params: {
+                code: string;
+                language: string;
+            };
+            examples: ({
+                code: string;
+                input?: undefined;
+            } | {
+                input: string;
+                code?: undefined;
+            })[];
+        };
+        start_release: {
+            description: string;
+            params: {
+                version: string;
+                from_tag: string;
+            };
+            examples: ({
+                version: string;
+                input?: undefined;
+            } | {
+                input: string;
+                version?: undefined;
+            })[];
+        };
+        start_refactor: {
+            description: string;
+            params: {
+                code: string;
+                goal: string;
+            };
+            examples: ({
+                code: string;
+                input?: undefined;
+            } | {
+                input: string;
+                code?: undefined;
+            })[];
+        };
+        start_onboard: {
+            description: string;
+            params: {
+                project_path: string;
+                docs_dir: string;
+            };
+            examples: ({
+                input: string;
+                project_path?: undefined;
+            } | {
+                project_path: string;
+                input?: undefined;
+            })[];
+        };
+        start_api: {
+            description: string;
+            params: {
+                code: string;
+                format: string;
+            };
+            examples: ({
+                code: string;
+                input?: undefined;
+            } | {
+                input: string;
+                code?: undefined;
+            })[];
+        };
+        start_doc: {
+            description: string;
+            params: {
+                code: string;
+                style: string;
+            };
+            examples: ({
+                input: string;
+                code?: undefined;
+            } | {
+                code: string;
+                input?: undefined;
+            })[];
+        };
+        gen_skill: {
+            description: string;
+            params: {
+                scope: string;
+                lang: string;
+            };
+            examples: ({
+                input: string;
+                scope?: undefined;
+                lang?: undefined;
+            } | {
+                scope: string;
+                lang: string;
+                input?: undefined;
+            })[];
+        };
+    };
+};