Claude Code

🚀 claude-code-mcp Project Documentation

claude-code-mcp is an MCP server project designed for interacting with Claude Code. It supports various functions such as code explanation, review, repair, editing, testing, command simulation, and custom queries.

🚀 Quick Start

Now you can run the server locally via npx without additional installation.

✨ Features

• Receive Requests: Handle JSON - formatted requests from clients.
• Process Input: Decode input content from Base64 and encode it in UTF - 8.
• Select Tools: Choose appropriate tools (e.g., explain_code, review_code, etc.) according to requirements.
• Generate Commands: Generate corresponding Claude CLI commands based on the context.
• Execute Commands: Execute the generated commands on the server - side and capture the output results.
• Return Results: Send the processed results back to the client in JSON format.

📦 Installation

Method 1: Using npx

Run directly via npx:

npx claude-code-mcp

Method 2: Global Installation

Install the global package using npm:

npm install -g claude-code-mcp

Method 3: Local Development

Clone the repository and run:

git clone https://github.com/yourusername/claude-code-mcp.git
cd claude-code-mcp
npm start

📚 Documentation

Configuration

Configure through environment variables. The following variables are supported:

• CLAUDE_BIN: Specify the path of the Claude CLI executable file.
• LOG_LEVEL: Set the log level, with the default being info.

Tool List

1. explain_code

Provide detailed explanations for the given code.

2. review_code

Review and evaluate the quality of the given code.

3. fix_code

Fix errors or issues in the code.

4. edit_code

Modify the code content according to instructions.

5. test_code

Generate test cases for the given code.

6. simulate_command

Simulate the execution process of commands.

7. your_own_query

Send custom query requests, supporting context information.

🔧 Technical Details

• Log Files: By default, log files are created in the project root directory. If it fails, it will try the user's home directory and /tmp directory in sequence.
• Log Rotation: This function has not been implemented yet. Please pay attention to the size of the log files.
• Main Testing Environment: Suitable for Ubuntu/WSL2 systems.

📄 License

This project is licensed under the MIT License. The specific content is as follows:

MIT License

Copyright (c) 2024 KunihiroS

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

⚠️ Important Note

This software is for educational and research purposes only. This project has no affiliation with Anthropic, and any commercial use without authorization is prohibited.

Claude is a trademark of Anthropic. This project uses Claude CLI as a dependency but is an independent community - driven project. Please ensure that you comply with Anthropic's terms of service.