Mcp Clean Code

MCP Clean Code

一个 MCP 服务实现，提供用于规划和创建整洁、结构良好的代码并配有全面英文注释的工具。

功能

• 逐步规划代码架构
• 设计模块化、易于维护的组件
• 遵循整洁代码原则和最佳实践
• 编写包含英文注释的全面文档
• 随着需求逐渐明确，修订设计决策
• 探索其他实现策略
• 注重代码的可读性和简洁性

工具

cleancode

帮助规划整洁代码，重点关注可读性、可维护性和结构良好的英文注释。

输入：

• thought (string)：当前的代码规划步骤
• nextThoughtNeeded (boolean)：是否需要继续进行下一步代码规划
• thoughtNumber (integer)：当前步骤编号
• totalThoughts (integer)：预计所需的总步骤数
• isRevision (boolean, optional)：是否在修订之前的规划步骤
• revisesThought (integer, optional)：正在重新考虑的步骤
• branchFromThought (integer, optional)：探索其他方案时的分支起始步骤编号
• branchId (string, optional)：其他实现方案的标识符
• needsMoreThoughts (boolean, optional)：是否需要更多规划步骤

用法

Clean Code 工具适用于：

• 在编写需要仔细规划的复杂代码之前
• 设计新功能或重构现有代码时
• 代码结构和组织至关重要时
• 确保文档全面且包含英文注释
• 遵循整洁代码原则和最佳实践
• 将复杂功能拆分为模块化组件
• 规划可测试且易于维护的实现

配置

在 Claude Desktop 中使用

将以下内容添加到你的 claude_desktop_config.json：

npm 安装

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

手动安装

# Install from npm
npm install -g mcp-clean-code

# Then use in configuration
{
  "mcpServers": {
    "cleancode": {
      "command": "mcp-clean-code"
    }
  }
}

PNPM 安装

# Install from npm using PNPM
pnpm add -g mcp-clean-code

# Then use in configuration
{
  "mcpServers": {
    "cleancode": {
      "command": "mcp-clean-code"
    }
  }
}

docker

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

构建

Docker：

docker build -t mcp-clean-code .

从源代码构建：

# Clone the repository
git clone https://github.com/your-username/mcp-clean-code.git
cd mcp-clean-code

# Install dependencies and build
pnpm install
pnpm build

GitHub Actions CI/CD

此仓库包含一个 GitHub Actions 工作流，可在创建新版本时自动将软件包发布到 npm。

设置 npm 自动发布

要启用向 npm 自动发布，你需要在 GitHub 仓库中添加一个 NPM_TOKEN 密钥：

1. 生成 npm 访问令牌：

   • 前往 npmjs.com 并登录
   • 点击右上角的个人头像，然后选择 "Access Tokens"
   • 点击 "Generate New Token"，并选择 "Publish" 选项
   • 复制生成的令牌

2. 将令牌添加到 GitHub 仓库：

   • 前往你的 GitHub 仓库
   • 点击 "Settings" > "Secrets and variables" > "Actions"
   • 点击 "New repository secret"
   • 名称：NPM_TOKEN
   • 值：粘贴从 npm 复制的令牌
   • 点击 "Add secret"

3. 创建新版本：

   • 前往你的 GitHub 仓库
   • 点击 "Releases" > "Create a new release"
   • 选择标签版本（例如，v1.0.0）
   • 添加版本标题和说明
   • 点击 "Publish release"

GitHub Actions 工作流将自动触发，构建软件包并将其发布到 npm。

许可证

此 MCP 服务采用 MIT 许可证授权，由 Aidalinfo (https://aidalinfo.fr) 开发。你可以自由使用、修改和分发此软件，但须遵守 MIT 许可证的条款和条件。