Codesavant Coding Assistant

🚀 MCP-CodeSavant

CodeSavant 是一個正在開發中的項目，它基於 Model Context Protocol (MCP) 構建，是一個強大的服務器。該服務器提供了代碼操作、執行和版本控制等功能，允許 AI 助手讀取、寫入和執行代碼，同時還能維護代碼更改的歷史記錄，為代碼開發和管理帶來了極大的便利。

🚀 快速開始

CodeSavant 是一個基於 Model Context Protocol (MCP) 的服務器，它為代碼操作、執行和版本控制提供了全面的支持。以下是快速開始使用 CodeSavant 的步驟：

1. 克隆倉庫：

git clone https://github.com/twolven/mcp-codesavant.git
cd mcp-codesavant

2. 安裝所需的依賴項：

pip install -r requirements.txt

3. 將服務器配置添加到您的 Claude 桌面 config.json 文件中：

{
    "mcpServers": {
        "codesavant": {
            "command": "python",
            "args": ["path/to/codesavant.py"]
        }
    }
}

✨ 主要特性

• 支持讀取和寫入代碼文件，並能按行進行特定操作，方便對代碼進行精細處理。
• 可在多種編程語言（Python、Node.js）中執行代碼，滿足不同開發需求。
• 能在受控環境中執行 shell 命令，增強了代碼執行的靈活性。
• 具備版本控制功能，可跟蹤和管理代碼更改，方便回溯和恢復代碼版本。
• 支持在代碼文件中搜索內容，提高查找代碼的效率。
• 可以將代碼恢復到先前版本，確保代碼的穩定性和可維護性。

📦 安裝指南

1. 克隆倉庫：

git clone https://github.com/twolven/mcp-codesavant.git
cd mcp-codesavant

2. 安裝所需的依賴項：

pip install -r requirements.txt

3. 將服務器配置添加到您的 Claude 桌面 config.json 文件中：

{
    "mcpServers": {
        "codesavant": {
            "command": "python",
            "args": ["path/to/codesavant.py"]
        }
    }
}

📚 詳細文檔

目錄結構

服務器創建和管理以下目錄結構：

workspaces/
├── project1/
│   ├── .code_history.json
│   └── [代碼文件]
├── project2/
│   ├── .code_history.json
│   └── [代碼文件]
└── ...

工具參考

1. 讀取代碼文件

• 功能：讀取指定路徑的代碼文件內容。
• 輸入示例：

{
    "project": "myproject",
    "path": "src/main.js"
}

• 輸出示例：

{
    "success": true,
    "timestamp": 1234567890,
    "data": {
        "content": "console.log('Hello World!');"
    }
}

2. 按行讀取代碼文件

• 功能：按指定的起始和結束行讀取代碼文件內容。
• 輸入示例：

{
    "project": "myproject",
    "path": "src/main.js",
    "start_line": 1,
    "end_line": 5
}

• 輸出示例：

{
    "success": true,
    "timestamp": 1234567890,
    "data": {
        "content": "console.log('Hello World!');\n// 第二行註釋"
    }
}

3. 執行代碼

• 功能：在指定語言環境中執行代碼。
• 輸入示例（Python）：

{
    "language": "python",
    "code": "print('Hello World!')"
}

• 輸出示例：

{
    "success": true,
    "timestamp": 1234567890,
    "data": {
        "output": "'Hello World!'\n"
    }
}

4. 執行 shell 命令

• 功能：在受控環境中執行 shell 命令。
• 輸入示例：

{
    "command": "ls -a"
}

• 輸出示例：

{
    "success": true,
    "timestamp": 1234567890,
    "data": {
        "output": ". .. .bashrc .config ..."
    }
}

5. 恢復到代碼版本

• 功能：將代碼文件恢復到指定時間戳的版本。
• 輸入示例：

{
    "path": "src/main.js",
    "timestamp": 1234567890
}

• 輸出示例：

{
    "success": true,
    "timestamp": 1234567890,
    "data": {
        "diff": {
            "changes": [["- console.log('Hello World!');", "+ console.log('Hi there!');"], ...],
            "timestamp": 1234567890
        }
    }
}

錯誤處理

服務器提供詳細的錯誤響應，格式如下：

{
    "success": false,
    "timestamp": 1234567890,
    "data": null,
    "error": "錯誤信息"
}

可能的錯誤類型包括：

• CodeFileError：文件操作錯誤
• CodeValidationError：代碼驗證錯誤
• CodeExecutionError：代碼執行錯誤

語言支持

目前支持以下語言用於代碼執行：

• Python（使用系統 Python 解釋器）
• Node.js（使用 node 命令）

每種語言的執行都會在工作區目錄中創建一個臨時文件，並使用相應的解釋器進行執行。

貢獻

1. 叉克隆倉庫
2. 創建功能分支
3. 提交更改
4. 推送到分支
5. 創建新的拉取請求

📄 許可證

本項目根據 MIT License 許可，詳細信息請參閱 LICENSE 文件。

作者

Todd Wolven - (https://github.com/twolven)

致謝

• 使用 Model Context Protocol (MCP) 構建
• 為 Anthropic 的 Claude 開發