🚀 MCP 代码清理工具

MCP 代码清理工具是一个 MCP 服务器实现，它提供了一个用于规划和创建干净、结构良好代码的工具，并且代码带有全面的英文注释。该工具能帮助开发者更好地组织代码，提升代码的可读性和可维护性。

🚀 快速开始

本工具可帮助开发者在编写代码前进行有效的规划，创建出符合干净代码原则的代码。下面将详细介绍其功能、使用场景和配置方法。

✨ 主要特性

• 代码架构规划：能够逐步计划代码架构，让代码从一开始就有清晰的结构。
• 模块化设计：设计出模块化、可维护的组件，方便后续的开发和扩展。
• 遵循最佳实践：严格遵循干净代码原则和最佳实践，保证代码质量。
• 全面文档注释：创建带有全面文档的代码，使用英文注释，便于团队协作和交流。
• 灵活设计决策：在需求更明确时可以重新审视设计决策，还能分支到替代实现策略。
• 注重代码质量：始终关注代码的可读性和简洁性，让代码易于理解和维护。

📦 安装指南

与Claude Desktop一起使用

你可以将以下内容添加到claude_desktop_config.json文件中进行配置。

npm安装

{
  "mcpServers": {
    "cleancode": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-clean-code"
      ]
    }
  }
}

手动安装

# 使用npm安装
npm install -g mcp-clean-code

# 然后在配置中使用
{
  "mcpServers": {
    "cleancode": {
      "command": "mcp-clean-code"
    }
  }
}

PNPM安装

# 使用PNPM安装
pnpm add -g mcp-clean-code

# 然后在配置中使用
{
  "mcpServers": {
    "cleancode": {
      "command": "mcp-clean-code"
    }
  }
}

Docker

{
  "mcpServers": {
    "cleancode": {
      "command": "docker",
      "args": [
        "run",
        "--rm",
        "-i"
      ]
    }
  }
}

💻 使用示例

基础用法

cleancode工具通过关注可读性、维护性和带有良好结构的英文注释来促进干净代码规划。其输入参数如下：

📚 详细文档

使用场景

Clean Code工具适用于以下场景：

• 在编写需要仔细规划的复杂代码之前。
• 设计新功能或重构现有代码时。
• 当代码结构和组织至关重要的时候。
• 为了确保带有全面文档的英文注释。
• 为了遵循干净代码原则和最佳实践。
• 将复杂的功能分解为模块化的组件。
• 为了计划可测试和维护的实现。