Comment Stripper MCP

🚀 靈活的模型上下文協議（MCP）服務器

這是一個靈活的模型上下文協議（MCP）服務器，支持批量處理多種編程語言的代碼文件以去除註釋。該工具採用 Node.js 和 TypeScript 開發，嚴格遵循測試驅動開發原則，並提供詳細的日誌記錄、性能優化配置以及身份驗證功能。

🚀 快速開始

項目運行

# 安裝依賴
npm install 或 yarn install

# 啟動開發環境
npm start 或 yarn start

# 啟動生產環境
NODE_ENV=production npm start 或 yarn start

日誌配置

默認日誌級別為 INFO，輸出到控制檯。如需調整日誌行為，請修改配置文件中的相關參數。

✨ 主要特性

• 支持批處理多語言代碼文件
• 自動檢測並去除常見編程語言的註釋
• 可選遞歸處理目錄中的所有子文件夾
• 提供進度跟蹤功能
• 內置日誌記錄系統
• 支持身份驗證
• 高性能配置選項

📦 安裝指南

# 安裝依賴
npm install 或 yarn install

💻 使用示例

基礎用法

# 安裝依賴
npm install 或 yarn install

# 啟動開發環境
npm start 或 yarn start

# 啟動生產環境
NODE_ENV=production npm start 或 yarn start

📚 詳細文檔

問題解決指南

若在運行過程中遇到服務器無法啟動或註釋去除失敗等問題，請參考以下步驟排查：

1. 檢查環境變量是否正確設置
2. 確保所有依賴已正確安裝
3. 查看日誌文件以獲取更多信息

配置說明

項目提供豐富的配置選項，可通過環境變量進行調節：

# 示例配置
HOST=127.0.0.1
PORT=3000
NODE_ENV=development
LOG_LEVEL=INFO
MAX_WORKERS=4

測試方法

項目採用 Jest 測試框架，並遵循嚴格的 TDD 開發流程。執行以下命令運行測試：

# 運行所有測試
npm test 或 yarn test

# 監視模式運行測試
npm run test:watch 或 yarn test:watch

# 生成測試覆蓋率報告
npm run test:coverage 或 yarn test:coverage

📄 API 文檔

去除註釋接口

URL: /api/remove-comments 請求方式: POST 參數說明:

• text: 需要處理的文本內容（可選）
• filePath: 單個文件路徑（可選）
• directoryPath: 目錄路徑（可選）
• recursive: 是否遞歸處理子目錄，默認為 true
• fileTypes: 需要處理的文件類型數組，默認處理所有支持類型
• trackProgress: 是否需要進度跟蹤，默認 false

響應示例:

{
  "success": true,
  "data": {
    "original": "// 原始代碼",
    "stripped": "// 註釋已移除"
  }
}

查詢進度接口

URL: /api/get-progress 請求方式: POST 參數說明:

• trackerId: 進度跟蹤 ID

響應示例:

{
  "success": true,
  "data": {
    "processed": 10,
    "total": 20,
    "percentage": 50,
    "completed": false
  }
}

查詢認證狀態接口

URL: /api/auth-status 請求方式: POST 響應示例:

{
  "success": true,
  "data": {
    "authEnabled": true,
    "authenticated": true,
    "message": "身份驗證成功"
  }
}

🤝 貢獻指南

歡迎貢獻！請通過 Pull Request 的方式提交代碼。

📄 許可證

本項目遵循 ISC 協議，具體內容見 LICENSE 文件。