Deskaid

🚀 代碼管理工具 codemcp 使用指南

本工具 codemcp 是一款代碼管理工具，它能夠實現代碼的自動化操作，如格式化和測試，還能與 Claude 交互，幫助開發者提升開發效率。

🚀 快速開始

安裝與配置

安裝依賴

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. 若尚未安裝 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

高級用法

項目提示

在 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"

📚 詳細文檔

理念與注意事項

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。

類型檢查

項目使用 pyright 進行類型檢查，配置如下：

1. 類型stub：
   • 自定義類型stub存放於 stubs/ 目錄。
   • 配置文件映射在 pyproject.toml 中。
2. 忽略策略：
   • 對複雜動態類型情況的文件使用特定忽略策略，通過 tool.pyright.ignoreExtraErrors 實現。 執行下列命令確保類型檢查通過：

./run_typecheck.sh

貢獻指南

查看 CONTRIBUTING.md 獲取貢獻信息。

🔧 技術細節

本工具主要基於 Python 開發，通過 pip 進行安裝。使用 toml 文件進行配置，結合 git 進行版本控制和提交管理。與 Claude 的交互實現了代碼的自動化修改和提交，同時提供了高級配置和故障排除的方法。

📄 許可證

文檔未提及相關許可證信息。

⚠️ 重要提示

1. 每次對話後需手動檢查提交內容。
2. 避免長時間連續操作以防超出限制。
3. 當達到速率限制時，進行其他任務如代碼審查或會議。

💡 使用建議

建議結合手動審查以保障代碼質量。