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）：別の実装を識別する ID
• 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

このリポジトリには、新しいリリースが作成されたときにパッケージを npm に自動公開する GitHub Actions ワークフローが含まれています。

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 ライセンスの利用規約に従う限り、ソフトウェアを自由に使用、変更、配布できます。