Claude Code MCP

🚀 claude-code-mcp Project Documentation

claude-code-mcp is a tool that offers a variety of code-related functions, including code explanation, review, fixing, editing, testing, and command simulation. It achieves these functions by invoking Anthropic's Claude CLI. The project is fully open - source and community - driven, with no commercial use involved.

🚀 Quick Start

Prerequisites

1. Ensure that Node.js (recommended version: LTS) is installed on your system.
2. Configure the environment variable CLAUDE_BIN to point to the executable file path of the Claude CLI.
3. Configure the logging level according to your needs.

Usage

Method 1: Run via npm package

npx claude-code-mcp

Method 2: Use for local development

Clone the repository, install dependencies, and start the project:

npm install
npm start

✨ Features

1. Functional Modules

• explain_code: Provide a detailed explanation of the given code.
• review_code: Review and evaluate the quality of the given code.
• fix_code: Fix errors or potential issues in the code.
• edit_code: Edit the code content according to instructions.
• test_code: Automatically generate test cases for the code.
• simulate_command: Simulate the behavior of executing a given command.
• your_own_query: Support custom queries and perform analysis based on context information.

2. Implementation

This tool is developed based on Node.js and interacts with the Claude CLI using standard input and output. Users can specify the path of the Claude CLI by configuring environment variables and choose the logging level (default is info).

3. Use Cases

• Educational and research purposes.
• Provide auxiliary functions such as code review and test generation.
• Support custom queries to meet personalized needs.

📦 Installation

Environment Variables

• CLAUDE_BIN: Specify the path of the Claude CLI. This is a required field.
  • Example: /home/user/.local/bin/claude (Linux) or C:\Users\User\AppData\Local\bin\claude.exe (Windows).
• LOG_LEVEL: Set the logging level. The default is info.
  • Optional values: debug, info, warn, error.

Configuration Files

Configuration can be done in the following ways:

1. Create a .env file in the project root directory and add environment variables.
2. Create a global configuration file ~/.claude-code-mcp.env.
3. Specify through command - line parameters at runtime.

💻 Usage Examples

Tools Provided

• explain_code: Provide a detailed explanation of the code.
• review_code: Review the code and provide suggestions.
• fix_code: Fix errors or issues in the code.
• edit_code: Edit the code according to instructions.
• test_code: Automatically generate test cases.
• simulate_command: Simulate the command execution process.
• your_own_query: Support custom queries based on context information.

Example

# Use the explain_code tool
claude-code-mcp --tool explain_code --code "function hello() { console.log('Hello, World!'); }"

📚 Documentation

Update Log

• Now you can run the MCP server using npx without local installation.

Notes

• Log Files: By default, log files will be created in the project root directory. If creation fails, it will attempt to write to the user's home directory or the /tmp directory.
• Log Rotation: The automatic log rotation function is not implemented yet. Please manage the log file size manually.
• Main Test Platform: This tool has been fully tested on the Linux system. Additional configuration may be required for the Windows platform.

📄 License

This project follows the MIT license, allowing users to freely use, modify, and distribute the code, provided that the copyright notice is retained.

Disclaimer

• This project is developed for educational and research purposes only.
• The project is not responsible for any consequences caused by improper use or any other means.
• Please comply with Anthropic's terms of service.