MCP Code Checker

🚀 MCP代码规范检查服务器

MCP代码规范检查服务器是一款用于执行代码规范检查和测试的实用工具。它能对项目代码进行静态分析和单元测试，帮助开发者识别代码质量问题、风格问题和潜在bug，确保代码的高质量与稳定性。

🚀 快速开始

若要使用MCP代码规范检查服务器，需完成安装和环境配置，并启动服务器。以下是详细步骤：

创建并激活虚拟环境（适用于Windows）

REM 克隆仓库
git clone https://github.com/yourusername/mcp-code-checker.git
cd mcp-code-checker

REM 创建并激活虚拟环境
python -m venv .venv
.venv\Scripts\activate

REM 安装依赖
pip install -e .

REM 安装开发依赖
pip install -e ".[dev]"

使用MCP开发工具运行服务器

# 设置PYTHONPATH并使用MCP开发工具启动服务器
set PYTHONPATH=. && mcp dev src/server.py

✨ 主要特性

• 运行Pylint检查：对项目代码进行静态分析，精准识别代码质量问题、风格问题和潜在bug。
• 运行Pytest测试：执行项目中的单元测试，并清晰报告测试结果。
• 综合检查：同时执行Pylint检查和Pytest测试，提供全面的综合结果。

📦 安装指南

创建并激活虚拟环境（适用于Windows）

REM 克隆仓库
git clone https://github.com/yourusername/mcp-code-checker.git
cd mcp-code-checker

REM 创建并激活虚拟环境
python -m venv .venv
.venv\Scripts\activate

REM 安装依赖
pip install -e .

REM 安装开发依赖
pip install -e ".[dev]"

使用MCP开发工具运行服务器

# 设置PYTHONPATH并使用MCP开发工具启动服务器
set PYTHONPATH=. && mcp dev src/server.py

💻 使用示例

基础用法

• 运行Pylint检查：无额外参数，直接运行整个项目的Pylint检查。

# 运行Pylint检查的命令示例
# 这里可根据实际情况补充具体命令

• 运行Pytest测试：无额外参数，直接运行整个项目的Pytest测试。

# 运行Pytest测试的命令示例
# 这里可根据实际情况补充具体命令

• 综合检查：支持配置Pylint和Pytest的相关参数。

# 运行综合检查的命令示例
# 这里可根据实际情况补充具体命令

📚 详细文档

功能模块

1. 运行Pylint检查

• 功能：对项目代码执行静态分析，报告代码质量问题。
• 输入：无额外参数，直接运行整个项目的Pylint检查。
• 输出：返回Pylint结果或提示LLM解释的提示信息。

2. 运行Pytest测试

• 功能：执行项目中的单元测试，报告测试结果。
• 输入：无额外参数，直接运行整个项目的Pytest测试。
• 输出：返回Pytest测试结果或提示LLM解释的提示信息。

3. 综合检查

• 功能：同时运行Pylint和Pytest检查，并返回综合结果。
• 输入：支持配置Pylint和Pytest的相关参数。
• 输出：返回所有检查的结果，或提示LLM进行综合解释。

安全特性

• 所有检查均在指定的项目目录内执行。
• 代码执行严格限制在Python测试文件范围内。
• 结果以适合人类和LLM解析的格式呈现。

开发说明

环境配置（适用于Windows）

REM 克隆仓库
git clone https://github.com/yourusername/mcp-code-checker.git
cd mcp-code-checker

REM 创建并激活虚拟环境
python -m venv .venv
.venv\Scripts\activate

REM 安装依赖
pip install -e .

REM 安装开发依赖
pip install -e ".[dev]"

使用MCP开发工具运行服务器

# 设置PYTHONPATH并使用MCP开发工具启动服务器
set PYTHONPATH=. && mcp dev src/server.py

📄 许可证

本项目基于MIT许可证发布，具体内容详见LICENSE文件。

⚠️ 重要提示

以上所有内容均为翻译结果，请根据实际需求调整配置参数和路径信息。