MCP 清洁代码

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

特性

• 逐步规划代码架构
• 设计模块化、可维护的组件
• 遵循清洁代码原则和最佳实践
• 创建具有全面英文注释的文档
• 随着需求变得更加清晰，修改设计决策
• 分支到替代实现策略
• 专注于代码可读性和简洁性

工具

cleancode

通过专注于可读性、可维护性和结构良好的英文注释，促进清洁代码规划。

输入：

• thought (字符串): 您当前的代码规划步骤
• nextThoughtNeeded (布尔值): 是否需要另一个代码规划步骤
• thoughtNumber (整数): 当前步骤编号
• totalThoughts (整数): 估计需要的总步骤数
• isRevision (布尔值, 可选): 这是否修改了之前的规划步骤
• revisesThought (整数, 可选): 正在重新考虑哪个步骤
• branchFromThought (整数, 可选): 替代方法的起始步骤编号
• branchId (字符串, 可选): 替代实现标识符
• needsMoreThoughts (布尔值, 可选): 是否需要更多规划步骤

用法

清洁代码工具专为以下情况设计：

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

配置

与 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 从 npm 安装
pnpm add -g mcp-clean-code

# 然后在配置中使用
{
  "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 .

从源码构建:

# 克隆仓库
git clone https://github.com/your-username/mcp-clean-code.git
cd mcp-clean-code

# 安装依赖并构建
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 许可证的条款和条件。