article
README
🚀 claude-code-mcp 项目文档
claude-code-mcp 是一个用于与 Claude Code 进行交互的 MCP 服务器项目。它具备代码解释、审查、修复等多种功能,为开发者提供便捷的代码处理体验。
🚀 快速开始
现在可以通过 npx 本地运行服务器,无需额外安装。
✨ 主要特性
- 接收请求:处理来自客户端的 JSON 格式请求。
- 处理输入:对输入内容进行 Base64 解码和 UTF-8 编码处理。
- 选择工具:根据需求选择合适的工具(如 explain_code、review_code 等)。
- 生成命令:基于上下文生成相应的 Claude CLI 命令。
- 执行命令:在服务器端执行生成的命令,并捕获输出结果。
- 返回结果:将处理后的结果以 JSON 格式回传给客户端。
📦 安装指南
方法一:使用 npx
直接通过 npx 运行:
npx claude-code-mcp
方法二:全局安装
使用 npm 安装全局包:
npm install -g claude-code-mcp
方法三:本地开发
克隆仓库后运行:
git clone https://github.com/yourusername/claude-code-mcp.git
cd claude-code-mcp
npm start
📚 详细文档
配置说明
通过环境变量进行配置,支持以下变量:
| 属性 | 详情 |
|------|------|
| CLAUDE_BIN | 指定 Claude CLI 可执行文件的路径 |
| LOG_LEVEL | 设置日志级别,默认为 info |
工具列表
1. explain_code
对给定代码提供详细解释。
2. review_code
审查并评估给定代码的质量。
3. fix_code
修复代码中的错误或问题。
4. edit_code
根据指令修改代码内容。
5. test_code
为给定代码生成测试用例。
6. simulate_command
模拟命令的执行过程。
7. your_own_query
发送自定义查询请求,支持上下文信息。
⚠️ 注意事项
⚠️ 重要提示
- 日志文件默认在项目根目录创建,若失败则依次尝试用户主目录和
/tmp目录。- 日志轮转功能尚未实现,请注意日志文件大小问题。
- 主要测试环境适用于 Ubuntu/WSL2 系统。
💡 使用建议
本软件仅用于教育和研究目的。该项目与 Anthropic 无关,未经授权禁止任何商业用途。Claude 是 Anthropic 的商标。此项目使用 Claude CLI 作为依赖项,但是一个独立的社区驱动项目。请确保遵守 Anthropic 的服务条款。
📄 许可证
本项目采用 MIT 许可证,具体内容如下:
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.
微信扫一扫