article
README
🚀 代码合并 MCP 服务器
代码合并 MCP 是一种基于 Model Context Protocol (MCP) 的服务器实现,专为代码文件内容提取、合并和分析而设计。它提供了一套强大的工具,能帮助大语言模型(如 GPT、Claude)更高效地处理和分析代码库。
✨ 主要特性
- 文件树生成:生成项目文件结构的树状视图。
- 代码合并:将多个文件的内容合并为单一输出。
- 代码分析:提供代码统计信息,如行数和函数数量。
- 智能过滤:支持 .gitignore 规则和自定义黑名单。
🔧 技术细节
本项目基于 Model Context Protocol (MCP) SDK 构建,使用 Node.js 实现。主要组件包括:
- MCP 服务器:处理客户端请求并提供工具功能。
- 工具模块:实现各种代码处理功能。
- 核心库:提供文件系统操作和过滤功能。
💻 使用示例
1. get_file_tree
生成项目文件结构的树状视图,支持多种过滤选项。
参数:
path:目标目录路径use_gitignore:是否使用 .gitignore 规则(可选)ignore_git:是否忽略 .git 目录(可选)custom_blacklist:自定义黑名单项目(可选)
示例输出:
project/
├── src/
│ ├── main.js
│ └── utils/
│ └── helper.js
├── tests/
│ └── test.js
└── README.md
2. merge_content
将多个文件的内容合并为单一输出,适合准备用于大语言模型的代码分析。
参数:
path:目标文件或目录路径compress:是否压缩输出(可选)use_gitignore:是否使用 .gitignore 规则(可选)ignore_git:是否忽略 .git 目录(可选)custom_blacklist:自定义黑名单项目(可选)
输出:包含合并后的文件内容和统计信息
3. analyze_code
分析代码文件并提供统计信息,如行数和函数数量。
参数:
path:目标文件或目录路径language:可选的语言过滤器countLines:是否统计代码行数countFunctions:是否统计函数数量
输出:包含代码分析结果的统计信息
📦 安装指南
环境要求
- Node.js (v16.x 或更高版本)
- MCP SDK
安装步骤
- 克隆项目仓库:
git clone https://github.com/yourusername/codemerge-mcp.git
cd codemerge-mcp
- 安装依赖项:
npm install
- 启动服务器:
node index.js
📚 详细文档
项目结构
codemerge-mcp/
├── index.js # MCP 服务器主程序
├── mcp-sdk/ # MCP SDK 目录(已包含)
│ ├── config.json # MCP 配置文件
│ └── lib/ # 核心库文件
├── tools/ # 工具模块目录
│ ├── filetree.js # 文件树生成工具
│ ├── merger.js # 代码合并工具
│ └── analyzer.js # 代码分析工具
└── README.md # 项目文档
贡献指南
- Fork 该项目到你的 GitHub 仓库。
- 在
tools/目录下添加新的功能模块。 - 提交并推送你的更改。
- 创建 Pull Request 进行代码审查。
📄 许可证
MIT License
致谢
本项目基于 TownBoats/codeMerge 开发,感谢原作者的贡献。
微信扫一扫