Deskaid

🚀 コード管理ツール codemcp の使用ガイド

このツールは開発効率を向上させることを目的としており、コード品質を保証するために手動でのレビューと併用することをおすすめします。

🚀 クイックスタート

インストール

依存関係のインストール

1. Python と pip がまだインストールされていない場合は、インストールしてください。
2. codemcp をインストールします。

   pip install codemcp
   

プロジェクトの設定

プロジェクトのルートディレクトリに codemcp.toml ファイルを作成し、以下の内容を記述します。

[commands]
format = ["black ."]
test = ["pytest tests/ --cov"]

使い方

プロジェクトの初期化

Claude Desktop で新しい Project を作成し、初期化コマンドを追加します。

Initialize codemcp with $PROJECT_DIR

ここで、$PROJECT_DIR は実際のプロジェクトパスに置き換えてください。

Claude とのやり取り

Claude を使ってコードを修正し、各対話の後に生成されたコミットを確認します。

git log --oneline --decorate

✨ 主な機能

自動化操作

• コードのフォーマット：!format コマンドを実行します。
• テストの実行：!test コマンドを実行します。

コミット履歴

各対話でコミットが生成され、git reflog を使って過去の変更を確認できます。

🔧 理念と注意事項

1. 手動介入：各対話の後、コミット内容を手動で確認する必要があります。
2. 乱用防止：長時間の連続操作を避け、制限を超えないようにしてください。
3. 経済モード：レート制限に達した場合は、コードレビューや会議などの他のタスクを行ってください。

📚 高度な設定

プロジェクトのプロンプト

codemcp.toml に初期プロンプトを追加します。

project_prompt = """
Before beginning work on this feature, write a short haiku.  Do this only once.
"""

カスタムコマンド

カスタムコマンドとそのドキュメントを設定します。

[commands.test]
command = ["pytest tests/ --cov"]
doc = "Runs the test suite with coverage"

🚧 トラブルシューティング

開発モード

デバッグサーバーを起動します。

PYTHONPATH=. mcp dev codemcp/__main__.py

ログ記録

グローバルなログレベルを設定します。

[logger]
verbosity = "INFO"  # 選択肢: DEBUG, INFO, WARNING, ERROR, CRITICAL

ログファイルは ~/.codemcp/codemcp.log に保存されます。

🤝 貢献ガイド

貢献に関する情報は CONTRIBUTING.md を参照してください。

🧐 型チェック

このプロジェクトでは pyright を使って型チェックを行います。設定方法は以下の通りです。

1. 型スタブ：

   • カスタム型スタブは stubs/ ディレクトリに保存します。
   • 設定ファイルのマッピングは pyproject.toml で行います。

2. 無視ポリシー：

   • 複雑な動的型のファイルには、tool.pyright.ignoreExtraErrors を使って特定の無視ポリシーを設定します。

以下のコマンドを実行して型チェックを通過させてください。

./run_typecheck.sh