金大哥 - comment-stripper-mcp MCP 详情

article

README

🚀 灵活的模型上下文协议（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

📚 详细文档

问题解决指南

若在运行过程中遇到服务器无法启动或注释去除失败等问题，请参考以下步骤排查：

检查环境变量是否正确设置
确保所有依赖已正确安装
查看日志文件以获取更多信息

配置说明

项目提供丰富的配置选项，可通过环境变量进行调节：

# 示例配置
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 文件。

comment-stripper-mcp