MCP Clean Code

🚀 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工具適用於以下場景：

• 在編寫需要仔細規劃的複雜代碼之前。
• 設計新功能或重構現有代碼時。
• 當代碼結構和組織至關重要的時候。
• 為了確保帶有全面文檔的英文註釋。
• 為了遵循乾淨代碼原則和最佳實踐。
• 將複雜的功能分解為模塊化的組件。
• 為了計劃可測試和維護的實現。