Comment Stripper MCP

🚀 Flexible Model Context Protocol (MCP) Server

This is a flexible Model Context Protocol (MCP) server that supports batch processing of code files in multiple programming languages to remove comments. Developed with Node.js and TypeScript, it adheres to test-driven development principles and offers detailed logging, performance optimization configurations, and authentication features.

🚀 Quick Start

Project Execution

# Install dependencies
npm install or yarn install

# Start the development environment
npm start or yarn start

# Start the production environment
NODE_ENV=production npm start or yarn start

Log Configuration

The default log level is INFO, and logs are output to the console. To adjust the log behavior, modify the relevant parameters in the configuration file.

✨ Features

• Support batch processing of multi-language code files
• Automatically detect and remove comments in common programming languages
• Optionally process all subfolders in a directory recursively
• Provide progress tracking functionality
• Built-in logging system
• Support authentication
• High-performance configuration options

📦 Installation

The project provides a wealth of configuration options that can be adjusted via environment variables:

# Example configuration
HOST=127.0.0.1
PORT=3000
NODE_ENV=development
LOG_LEVEL=INFO
MAX_WORKERS=4

💻 Usage Examples

The project uses the Jest testing framework and follows a strict TDD development process. Execute the following commands to run tests:

# Run all tests
npm test or yarn test

# Run tests in watch mode
npm run test:watch or yarn test:watch

# Generate test coverage reports
npm run test:coverage or yarn test:coverage

📚 Documentation

Remove Comments API

URL: /api/remove-comments Request Method: POST Parameter Description:

• text: Text content to be processed (optional)
• filePath: Single file path (optional)
• directoryPath: Directory path (optional)
• recursive: Whether to process subdirectories recursively, default is true
• fileTypes: Array of file types to be processed, default is all supported types
• trackProgress: Whether progress tracking is required, default is false

Response Example:

{
  "success": true,
  "data": {
    "original": "// Original code",
    "stripped": "// Comments removed"
  }
}

Query Progress API

URL: /api/get-progress Request Method: POST Parameter Description:

• trackerId: Progress tracking ID

Response Example:

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

Query Authentication Status API

URL: /api/auth-status Request Method: POST Response Example:

{
  "success": true,
  "data": {
    "authEnabled": true,
    "authenticated": true,
    "message": "Authentication successful"
  }
}

🛠️ Troubleshooting

If you encounter issues such as the server failing to start or comment removal failures during operation, please refer to the following steps for troubleshooting:

1. Check if the environment variables are correctly set.
2. Ensure that all dependencies are correctly installed.
3. Check the log files for more information.

🤝 Contribution Guidelines

Contributions are welcome! Please submit your code via Pull Request.

📄 License

This project follows the ISC license. For specific details, please refer to the LICENSE file.