mcp-probe-kit 1.8.0 → 1.8.1

package/docs/specs/init-project-context/requirements.md

@@ -1,144 +0,0 @@
-# 需求文档：init_project_context
-
-## 功能概述
-
-`init_project_context` 是一个 MCP 工具，用于分析已有项目并生成项目上下文文档。该文档将作为后续功能开发的基础，帮助 AI 理解项目的技术栈、架构模式和编码规范。
-
-## 术语定义
-
-- **Project_Context**: 项目上下文，包含项目的核心信息（技术栈、架构、规范等）
-- **Context_Document**: 上下文文档，即 `docs/project-context.md` 文件
-- **Tech_Stack**: 技术栈，项目使用的语言、框架、工具等
-- **Architecture_Pattern**: 架构模式，项目的代码组织方式
-
----
-
-## 需求列表
-
-### 需求 1: 生成项目上下文文档
-
-**用户故事:** 作为开发者，我想要自动生成项目上下文文档，以便 AI 能够理解项目并提供更准确的帮助。
-
-#### 验收标准
-
-1. WHEN 用户调用 init_project_context 工具 THEN 系统 SHALL 返回详细的项目分析指南
-2. THE 指南 SHALL 包含以下分析步骤：
-   - 技术栈分析（语言、框架、构建工具）
-   - 项目结构分析（目录结构、入口文件）
-   - 编码规范分析（ESLint、Prettier 配置）
-   - 依赖分析（生产依赖、开发依赖）
-3. THE 指南 SHALL 包含标准化的文档模板
-4. THE 指南 SHALL 包含质量检查清单
-
----
-
-### 需求 2: 支持自定义文档目录
-
-**用户故事:** 作为开发者，我想要自定义文档存放目录，以便适应不同项目的目录结构。
-
-#### 验收标准
-
-1. WHEN 用户提供 docs_dir 参数 THEN 系统 SHALL 在指南中使用该目录路径
-2. WHEN 用户未提供 docs_dir 参数 THEN 系统 SHALL 使用默认值 "docs"
-3. THE 指南 SHALL 明确指出文档的完整输出路径
-
----
-
-### 需求 3: 提供结构化的文档模板
-
-**用户故事:** 作为开发者，我想要使用标准化的文档模板，以便生成的文档格式一致。
-
-#### 验收标准
-
-1. THE 文档模板 SHALL 包含以下章节：
-   - 项目概览（名称、版本、类型、描述）
-   - 技术栈（语言、运行时、框架、构建工具、包管理器）
-   - 项目结构（目录树、模块说明）
-   - 架构模式（设计模式、模块划分）
-   - 编码规范（代码风格、命名规范、TypeScript 配置）
-   - 依赖管理（主要依赖、开发依赖）
-   - 开发流程（启动命令、构建命令、测试命令）
-2. THE 模板 SHALL 使用 Markdown 格式
-3. THE 模板 SHALL 包含占位符，指示 AI 需要填充的内容
-
----
-
-### 需求 4: 提供质量检查清单
-
-**用户故事:** 作为开发者，我想要有一个检查清单，以便验证生成的文档是否完整和准确。
-
-#### 验收标准
-
-1. THE 指南 SHALL 在末尾包含检查清单
-2. THE 检查清单 SHALL 包含以下检查项：
-   - 所有占位符都已填充实际内容
-   - 技术栈信息准确
-   - 目录结构清晰
-   - 依赖列表完整
-   - 文档格式正确
-3. THE 检查清单 SHALL 使用 Markdown 复选框格式
-
----
-
-### 需求 5: 兼容多种 AI 模型
-
-**用户故事:** 作为工具开发者，我想要提示词能被多种 AI 模型正确理解，以便工具具有广泛的兼容性。
-
-#### 验收标准
-
-1. THE 指南 SHALL 使用清晰、无歧义的语言
-2. THE 指南 SHALL 使用结构化的 Markdown 格式
-3. THE 指南 SHALL 避免使用特定 AI 模型的术语
-4. THE 指南 SHALL 每个步骤都有明确的输入和输出
-5. THE 指南 SHALL 使用编号列表表示顺序步骤
-6. THE 指南 SHALL 使用代码块展示文件内容和命令
-
----
-
-## 非功能需求
-
-### 性能要求
-- 工具响应时间应小于 100ms（仅返回指南文本）
-
-### 兼容性要求
-- 支持 Cursor、Gemini、Codex、Claude、GLM4.7 等主流 AI 模型
-- 支持 Windows、macOS、Linux 操作系统
-
-### 可维护性要求
-- 提示词模板应易于更新和维护
-- 文档模板应与最佳实践保持同步
-
----
-
-## 输入输出规格
-
-### 输入参数
-
-| 参数名 | 类型 | 必填 | 默认值 | 描述 |
-|--------|------|------|--------|------|
-| docs_dir | string | 否 | "docs" | 文档存放目录 |
-
-### 输出格式
-
-```typescript
-{
-  content: [
-    {
-      type: "text",
-      text: "详细的项目分析指南（Markdown 格式）"
-    }
-  ]
-}
-```
-
----
-
-## 依赖关系
-
-- 无外部依赖
-- 不依赖其他 MCP 工具
-
----
-
-*文档版本: 1.0.0*
-*创建时间: 2025-01-14*

package/docs/specs/init-project-context/tasks.md

@@ -1,93 +0,0 @@
-# 任务清单：init_project_context
-
-## 概述
-
-实现 `init_project_context` MCP 工具，用于生成项目上下文文档。
-
----
-
-## 任务列表
-
-### 阶段 1: 创建工具文件
-
-- [ ] 1.1 创建 `src/tools/init_project_context.ts` 文件
-  - 创建文件结构
-  - 定义接口类型
-  - 实现主函数框架
-  - _需求: 1.1, 2.1_
-
-- [ ] 1.2 编写提示词模板
-  - 实现完整的 PROMPT_TEMPLATE 常量
-  - 包含任务目标、执行步骤、文档模板、检查清单
-  - 确保兼容多种 AI 模型
-  - _需求: 1.2, 1.3, 1.4, 5.1-5.6_
-
----
-
-### 阶段 2: 注册工具
-
-- [ ] 2.1 在 `src/tools/index.ts` 中导出工具
-  - 添加 export 语句
-  - _需求: 1.1_
-
-- [ ] 2.2 在 `src/index.ts` 中注册工具
-  - 添加工具定义（name, description, inputSchema）
-  - 添加工具处理逻辑（switch case）
-  - 更新资源状态
-  - _需求: 1.1, 2.1, 2.2_
-
----
-
-### 阶段 3: 更新文档
-
-- [ ] 3.1 更新 README.md
-  - 添加工具说明
-  - 添加使用示例
-  - 更新工具数量（24 → 25）
-  - _需求: 1.1_
-
-- [ ] 3.2 更新 package.json
-  - 更新版本号（如需要）
-  - 更新描述中的工具数量
-  - _需求: 1.1_
-
----
-
-### 阶段 4: 测试验证
-
-- [ ] 4.1 编译项目
-  - 运行 `npm run build`
-  - 确保无编译错误
-  - _需求: 1.1_
-
-- [ ] 4.2 功能测试
-  - 测试默认参数调用
-  - 测试自定义 docs_dir 参数
-  - 验证返回的指南内容完整
-  - _需求: 1.1, 2.1, 2.2_
-
----
-
-## 检查点
-
-- [ ] 阶段 1 完成后：工具文件创建完成，提示词模板完整
-- [ ] 阶段 2 完成后：工具已注册，可以被调用
-- [ ] 阶段 3 完成后：文档已更新
-- [ ] 阶段 4 完成后：编译通过，功能正常
-
----
-
-## 文件变更清单
-
-| 文件 | 操作 | 说明 |
-|------|------|------|
-| src/tools/init_project_context.ts | 新建 | 工具实现 |
-| src/tools/index.ts | 修改 | 添加导出 |
-| src/index.ts | 修改 | 注册工具 |
-| README.md | 修改 | 添加文档 |
-| package.json | 修改 | 更新描述 |
-
----
-
-*任务版本: 1.0.0*
-*创建时间: 2025-01-14*

package/docs/specs/security-scan/design.md

@@ -1,152 +0,0 @@
-# 设计文档：security_scan
-
-## 概述
-
-`security_scan` 采用"提示词生成器"模式，返回详细的安全扫描分析指南，由 AI 执行实际的代码安全分析。
-
----
-
-## 技术方案
-
-### 设计模式
-
-与其他工具一致，采用"指令生成器"模式：
-- 工具不直接执行扫描
-- 返回结构化的安全检查清单
-- AI 根据清单分析代码并生成报告
-
-### 安全检查规则库
-
-```typescript
-const SECURITY_RULES = {
-  injection: [
-    { id: "SQL-001", name: "SQL 注入", pattern: "字符串拼接 SQL", cwe: "CWE-89" },
-    { id: "XSS-001", name: "XSS 攻击", pattern: "未转义的用户输入", cwe: "CWE-79" },
-    { id: "CMD-001", name: "命令注入", pattern: "exec/spawn 拼接", cwe: "CWE-78" },
-  ],
-  auth: [
-    { id: "AUTH-001", name: "硬编码密码", pattern: "password = '...'", cwe: "CWE-798" },
-    { id: "AUTH-002", name: "弱密码策略", pattern: "密码长度 < 8", cwe: "CWE-521" },
-  ],
-  crypto: [
-    { id: "CRYPTO-001", name: "弱哈希算法", pattern: "MD5/SHA1", cwe: "CWE-328" },
-    { id: "CRYPTO-002", name: "不安全随机数", pattern: "Math.random()", cwe: "CWE-330" },
-  ],
-  sensitive_data: [
-    { id: "DATA-001", name: "日志泄露", pattern: "console.log(password)", cwe: "CWE-532" },
-    { id: "DATA-002", name: "错误信息泄露", pattern: "返回堆栈信息", cwe: "CWE-209" },
-  ]
-};
-```
-
----
-
-## 架构设计
-
-### 工具结构
-
-```
-src/tools/security_scan.ts
-├── securityScan(args)           # 主函数
-│   ├── 验证参数
-│   ├── 构建扫描指南
-│   └── 返回结果
-└── 常量定义
-    ├── SECURITY_RULES           # 安全规则库
-    └── PROMPT_TEMPLATE          # 提示词模板
-```
-
-### 数据流
-
-```
-用户调用工具（提供代码）
-    ↓
-验证参数
-    ↓
-构建安全扫描指南（包含规则清单）
-    ↓
-返回 MCP 响应
-    ↓
-AI 按指南分析代码
-    ↓
-生成安全报告
-```
-
----
-
-## 提示词模板设计
-
-```markdown
-# 安全扫描指南
-
-## 🎯 扫描目标
-对以下代码进行安全扫描：
-\`\`\`{language}
-{code}
-\`\`\`
-
-## 📋 扫描清单
-
-### 1. 注入类漏洞检查
-- [ ] SQL 注入：检查 SQL 语句是否使用参数化查询
-- [ ] XSS：检查用户输入是否正确转义
-- [ ] 命令注入：检查 exec/spawn 是否拼接用户输入
-
-### 2. 认证授权检查
-- [ ] 硬编码凭证：搜索 password, secret, key, token
-- [ ] 认证绕过：检查权限验证逻辑
-
-### 3. 加密安全检查
-- [ ] 弱算法：检查是否使用 MD5, SHA1, DES
-- [ ] 随机数：检查是否使用 Math.random() 生成安全相关数据
-
-### 4. 敏感数据检查
-- [ ] 日志泄露：检查日志是否包含敏感信息
-- [ ] 错误处理：检查是否向用户暴露堆栈信息
-
-## 📊 报告模板
-
-### 漏洞摘要
-| 严重程度 | 数量 |
-|----------|------|
-| Critical | 0 |
-| High | 0 |
-| Medium | 0 |
-| Low | 0 |
-
-### 漏洞详情
-#### [漏洞ID] 漏洞名称
-- **严重程度**: Critical/High/Medium/Low
-- **CWE**: CWE-XXX
-- **位置**: 第 X 行
-- **问题代码**:
-\`\`\`
-[问题代码]
-\`\`\`
-- **修复建议**:
-\`\`\`
-[修复后的代码]
-\`\`\`
-
-### 安全建议
-[通用安全建议]
-```
-
----
-
-## 接口设计
-
-```typescript
-interface SecurityScanArgs {
-  code: string;           // 必填
-  language?: string;      // 可选，默认 auto
-  scan_type?: string;     // 可选，默认 all
-}
-
-async function securityScan(args: SecurityScanArgs): Promise<MCPResponse>
-```
-
----
-
-*设计版本: 1.0.0*
-*创建时间: 2025-01-14*

package/docs/specs/security-scan/requirements.md

@@ -1,150 +0,0 @@
-# 需求文档：security_scan
-
-## 功能概述
-
-`security_scan` 是一个 MCP 工具，用于分析代码的安全性问题。检测常见漏洞、不安全的编码实践，并提供修复建议。
-
-## 术语定义
-
-- **Vulnerability**: 安全漏洞，可被攻击者利用的代码缺陷
-- **CWE**: Common Weakness Enumeration，通用缺陷枚举
-- **OWASP**: Open Web Application Security Project，开放式 Web 应用安全项目
-- **Severity**: 严重程度，分为 Critical/High/Medium/Low/Info
-
----
-
-## 需求列表
-
-### 需求 1: 接收代码输入
-
-**用户故事:** 作为开发者，我想要提交代码进行安全扫描，以便发现潜在的安全问题。
-
-#### 验收标准
-
-1. THE 工具 SHALL 接受以下输入参数：
-   - code: 需要扫描的代码（必填）
-   - language: 编程语言（可选，自动检测）
-   - scan_type: 扫描类型（可选，默认 all）
-2. THE scan_type SHALL 支持以下值：
-   - all: 全面扫描
-   - injection: 注入类漏洞
-   - auth: 认证授权问题
-   - crypto: 加密问题
-   - sensitive_data: 敏感数据泄露
-
----
-
-### 需求 2: 检测注入类漏洞
-
-**用户故事:** 作为开发者，我想要检测注入类漏洞，以便防止 SQL 注入、XSS 等攻击。
-
-#### 验收标准
-
-1. THE 工具 SHALL 检测以下注入类型：
-   - SQL 注入
-   - XSS（跨站脚本）
-   - 命令注入
-   - LDAP 注入
-   - XPath 注入
-2. THE 工具 SHALL 标注漏洞位置和代码行
-3. THE 工具 SHALL 提供修复示例代码
-
----
-
-### 需求 3: 检测认证授权问题
-
-**用户故事:** 作为开发者，我想要检测认证授权问题，以便防止未授权访问。
-
-#### 验收标准
-
-1. THE 工具 SHALL 检测以下问题：
-   - 硬编码密码/密钥
-   - 弱密码策略
-   - 缺少认证检查
-   - 权限提升风险
-   - Session 管理问题
-2. THE 工具 SHALL 提供安全的替代方案
-
----
-
-### 需求 4: 检测加密问题
-
-**用户故事:** 作为开发者，我想要检测加密相关问题，以便确保数据安全。
-
-#### 验收标准
-
-1. THE 工具 SHALL 检测以下问题：
-   - 使用弱加密算法（MD5, SHA1, DES）
-   - 不安全的随机数生成
-   - 密钥管理问题
-   - 明文传输敏感数据
-2. THE 工具 SHALL 推荐安全的加密方案
-
----
-
-### 需求 5: 检测敏感数据泄露
-
-**用户故事:** 作为开发者，我想要检测敏感数据泄露风险，以便保护用户隐私。
-
-#### 验收标准
-
-1. THE 工具 SHALL 检测以下问题：
-   - 日志中包含敏感信息
-   - 错误信息泄露
-   - 注释中的敏感数据
-   - 配置文件中的明文密码
-2. THE 工具 SHALL 建议数据脱敏方案
-
----
-
-### 需求 6: 生成安全报告
-
-**用户故事:** 作为开发者，我想要获得结构化的安全报告，以便有优先级地修复问题。
-
-#### 验收标准
-
-1. THE 报告 SHALL 包含：
-   - 漏洞摘要（按严重程度分类）
-   - 详细漏洞列表
-   - 每个漏洞的 CWE 编号
-   - 修复建议和示例代码
-   - 安全最佳实践建议
-2. THE 报告 SHALL 按严重程度排序
-
----
-
-## 非功能需求
-
-### 性能要求
-- 工具响应时间应小于 200ms
-
-### 准确性要求
-- 减少误报，提供置信度评分
-
----
-
-## 输入输出规格
-
-### 输入参数
-
-| 参数名 | 类型 | 必填 | 默认值 | 描述 |
-|--------|------|------|--------|------|
-| code | string | 是 | - | 需要扫描的代码 |
-| language | string | 否 | auto | 编程语言 |
-| scan_type | string | 否 | all | 扫描类型 |
-
-### 输出格式
-
-```typescript
-{
-  content: [{
-    type: "text",
-    text: "安全扫描报告（Markdown 格式）"
-  }]
-}
-```
-
----
-
-*文档版本: 1.0.0*
-*创建时间: 2025-01-14*

package/docs/specs/security-scan/tasks.md

@@ -1,67 +0,0 @@
-# 任务清单：security_scan
-
-## 概述
-
-实现 `security_scan` MCP 工具，用于代码安全扫描和漏洞检测。
-
----
-
-## 任务列表
-
-### 阶段 1: 创建工具文件
-
-- [x] 1.1 创建 `src/tools/security_scan.ts` 文件
-  - 创建文件结构
-  - 定义接口类型
-  - 实现参数验证
-  - 实现主函数框架
-  - _需求: 1.1-1.2_
-
-- [x] 1.2 编写提示词模板
-  - 实现 PROMPT_TEMPLATE 常量
-  - 包含注入类漏洞检查清单
-  - 包含认证授权检查清单
-  - 包含加密安全检查清单
-  - 包含敏感数据检查清单
-  - 包含报告模板
-  - _需求: 2.1-6.2_
-
----
-
-### 阶段 2: 注册工具
-
-- [x] 2.1 在 `src/tools/index.ts` 中导出工具
-  - 添加 export 语句
-
-- [x] 2.2 在 `src/index.ts` 中注册工具
-  - 添加工具定义（name, description, inputSchema）
-  - 添加工具处理逻辑（switch case）
-
----
-
-### 阶段 3: 测试验证
-
-- [x] 3.1 编译项目
-  - 运行 `npm run build`
-  - 确保无编译错误
-
-- [ ] 3.2 功能测试
-  - 测试 SQL 注入检测
-  - 测试 XSS 检测
-  - 测试硬编码密码检测
-  - 测试弱加密算法检测
-
----
-
-## 文件变更清单
-
-| 文件 | 操作 | 说明 |
-|------|------|------|
-| src/tools/security_scan.ts | 新建 | 工具实现 |
-| src/tools/index.ts | 修改 | 添加导出 |
-| src/index.ts | 修改 | 注册工具 |
-
----
-
-*任务版本: 1.0.0*
-*创建时间: 2025-01-14*

package/docs/specs/start-bugfix/design.md

@@ -1,42 +0,0 @@
-# 设计文档：start_bugfix
-
-## 概述
-
-`start_bugfix` 采用"编排指南"模式，指导 AI 完成完整的 Bug 修复流程。
-
----
-
-## 编排流程
-
-```
-用户调用 start_bugfix
-    ↓
-返回编排指南
-    ↓
-AI 执行步骤 0: 检查/生成项目上下文
-    ↓
-AI 执行步骤 1: 调用 fix_bug（定位→分析→修复）
-    ↓
-AI 执行步骤 2: 调用 gentest（生成回归测试）
-    ↓
-AI 执行步骤 3: 调用 gencommit（生成提交消息）
-    ↓
-AI 汇总输出
-```
-
----
-
-## 接口设计
-
-```typescript
-interface StartBugfixArgs {
-  error_message: string;   // 必填
-  stack_trace?: string;    // 可选
-}
-
-async function startBugfix(args: StartBugfixArgs): Promise<MCPResponse>
-```
-
----
-
-*设计版本: 1.0.0*

package/docs/specs/start-bugfix/requirements.md

@@ -1,70 +0,0 @@
-# 需求文档：start_bugfix
-
-## 功能概述
-
-`start_bugfix` 是一个智能编排工具，用于自动化 Bug 修复流程。从问题分析到测试验证再到提交，一站式完成。
-
----
-
-## 需求列表
-
-### 需求 1: 自动检查项目上下文
-
-#### 验收标准
-
-1. THE 工具 SHALL 检查 `docs/project-context.md` 是否存在
-2. IF 不存在 THEN 工具 SHALL 指导先调用 `init_project_context`
-
----
-
-### 需求 2: 编排 Bug 分析修复
-
-#### 验收标准
-
-1. THE 工具 SHALL 指导调用 `fix_bug` 进行分析
-2. THE 工具 SHALL 传递 error_message 和 stack_trace
-
----
-
-### 需求 3: 编排测试生成
-
-#### 验收标准
-
-1. THE 工具 SHALL 指导调用 `gentest` 生成回归测试
-2. THE 工具 SHALL 根据项目上下文选择测试框架
-
----
-
-### 需求 4: 编排 Commit 生成
-
-#### 验收标准
-
-1. THE 工具 SHALL 指导调用 `gencommit` 生成提交消息
-2. THE 工具 SHALL 使用 fix 类型
-
----
-
-## 输入输出规格
-
-### 输入参数
-
-| 参数名 | 类型 | 必填 | 描述 |
-|--------|------|------|------|
-| error_message | string | 是 | 错误信息 |
-| stack_trace | string | 否 | 堆栈跟踪 |
-
-### 编排流程
-
-```
-start_bugfix
-    ↓
-[检查 project-context.md]
-    ↓
-fix_bug → gentest → gencommit
-    ↓
-输出汇总
-```
-
----
-
-*文档版本: 1.0.0*