使用说明
项目简介
该MCP服务器名为 "vitest-server",旨在为LLM客户端提供代码质量检测能力。它集成了 Vitest 测试框架和 TypeScript 编译器,允许开发者通过 MCP 协议远程触发单元测试和类型检查,并获取结构化的结果报告。这使得 LLM 能够理解代码的测试覆盖率和潜在的类型错误,从而更好地进行代码分析和辅助开发任务。
主要功能点
- 单元测试执行 (run_tests): 能够运行指定项目目录下的 Vitest 单元测试。可以指定要运行的测试文件或运行所有测试。服务器将返回测试结果的详细报告,包括通过、失败、跳过的测试数量,以及失败测试的错误信息和差异对比。
- TypeScript 类型检查 (type_check): 对指定项目目录执行 TypeScript 类型检查。服务器会分析项目代码,并返回所有类型错误报告,包括错误的文件路径、行号、列号、错误代码和详细错误消息。
安装步骤
- 安装 Node.js 和 npm: 确保你的开发环境中已安装 Node.js 和 npm (Node Package Manager)。
- 克隆仓库: 使用 Git 克隆该 GitHub 仓库到本地:
git clone https://github.com/tonyhschu/test-and-typecheck-mcp-server.git - 进入项目目录: 导航到克隆下来的项目目录:
cd test-and-typecheck-mcp-server - 安装依赖: 使用 npm 安装项目所需的依赖包:
npm install - 构建项目: 构建 TypeScript 项目,生成可执行的 JavaScript 代码:
构建完成后,编译后的 'index.js' 文件将位于 'build' 目录下。npm run build
服务器配置
为了让 MCP 客户端能够连接到该服务器,需要提供如下配置信息。请根据你的实际环境修改路径。
{ "serverName": "vitest-server", "command": "/path/to/test-and-typecheck-mcp-server/build/index.js", "args": ["/path/to/your/project"] // "command": "node", // 如果你希望直接使用 node 运行 // "args": ["/path/to/test-and-typecheck-mcp-server/build/index.js", "/path/to/your/project"] // 将 "/path/to/test-and-typecheck-mcp-server/build/index.js" 替换为构建后的 index.js 文件的实际绝对路径。 // 将 "/path/to/your/project" 替换为你想要进行测试或类型检查的项目目录的实际绝对路径。 // 注意:MCP客户端需要配置服务器的启动命令 (command) 及其参数 (args),以便建立连接并调用工具。 }
基本使用方法
- 启动 MCP 服务器: MCP 客户端会根据上述配置信息启动 'vitest-server'。服务器启动后,将通过 Stdio 协议等待客户端的请求。
- 客户端发送请求: MCP 客户端可以使用 'ListTools' 请求查询服务器支持的工具,这将返回 "run_tests" 和 "type_check" 两个工具。
- 调用工具: 客户端可以使用 'CallTool' 请求来调用具体的工具。
- 调用 'run_tests' 工具: 可以传递 'testFiles' 参数 (字符串或字符串数组) 指定要运行的测试文件,如果不提供则默认运行所有测试。
- 调用 'type_check' 工具: 可以传递 'files' 参数 (字符串或字符串数组) 指定要进行类型检查的文件,如果不提供则默认检查整个项目。
- 接收响应: 服务器执行相应的工具后,会将结果封装在 JSON-RPC 响应中返回给客户端。例如,'run_tests' 工具会返回格式化的测试结果报告,'type_check' 工具会返回格式化的类型错误报告。
信息
分类
开发者工具