🚀 源木 Sage MCP 服务器

源木 Sage MCP 服务器为开发者提供了便捷的 MCP 服务，具备目录树构建、文件过滤、内容生成等功能，能高效处理大规模项目。

🚀 快速开始

若你想快速体验源木 Sage MCP 服务器，可按照以下步骤操作：

# 克隆仓库
git clone https://github.com/sunwood-ai-labs/source-sage-mcp-server.git
# 进入目录
cd source-sage-mcp-server
# 安装依赖项
npm install
# 构建项目
npm run build
# 启动开发服务器
npm run inspector

✨ 主要特性

• 服务器类：SourceSageServer 类提供 MCP 服务器的核心功能。
• 目录树构建：使用 buildTree 方法递归解析目录结构，并合理排序目录和文件以实现良好的显示效果。
• 文件过滤：使用 ignore 包实现灵活的文件排除功能，支持丰富的默认排除模式和自定义设置。
• 内容生成：根据文件类型提供适当的语法高亮，并根据文件种类提供额外信息。
• 异步处理：使用 glob 包实现高效的文件遍历，通过异步处理支持大规模项目。

📦 安装指南

安装步骤

1. 克隆仓库

   git clone https://github.com/sunwood-ai-labs/source-sage-mcp-server.git
   

2. 进入目录

   cd source-sage-mcp-server
   

3. 安装依赖项

   npm install
   

4. 构建项目

   npm run build
   

5. 启动开发服务器

   npm run inspector
   

📚 详细文档

配置指南

忽略文件配置

在项目根目录下创建或修改 .SourceSageignore 文件，添加需要忽略的文件和目录：

# 版本控制相关
.git
.gitignore

# 缓存文件
__pycache__
.pytest_cache
**/__pycache__/**
*.pyc

# 构建与发布相关
build
dist
*.egg-info

# 临时文件与输出
output
output.md
test_output
.SourceSageAssets
.SourceSageAssetsDemo

# 资源文件
*.png
*.svg
assets

# 其他
LICENSE
example
folder
package-lock.json

使用指南

核心功能

• 服务器类：SourceSageServer 类提供 MCP 服务器的核心功能。
• 目录树构建：使用 buildTree 方法递归解析目录结构，合理排序目录和文件以实现良好的显示效果。
• 文件过滤：使用 ignore 包实现灵活的文件排除功能，支持丰富的默认排除模式和自定义设置。
• 内容生成：根据文件类型提供适当的语法高亮，根据文件种类提供额外信息。
• 异步处理：使用 glob 包实现高效的文件遍历，通过异步处理支持大规模项目。

开发服务器启动

npm run inspector

开发者指南

主要实现细节

• 服务器类：SourceSageServer 类提供 MCP 服务器的核心功能。
• 目录树构建：使用 buildTree 方法递归解析目录结构，合理排序目录和文件以实现良好的显示效果。
• 文件过滤：使用 ignore 包实现灵活的文件排除功能，支持丰富的默认排除模式和自定义设置。
• 内容生成：根据文件类型提供适当的语法高亮，根据文件种类提供额外信息。
• 异步处理：使用 glob 包实现高效的文件遍历，通过异步处理支持大规模项目。

开发环境搭建

# 克隆仓库
git clone https://github.com/sunwood-ai-labs/source-sage-mcp-server.git
# 安装依赖
npm install
# 开发构建
npm run build
# 启动开发服务器
npm run inspector

贡献指南

提交代码规范

1. Fork 仓库

   git fork https://github.com/sunwood-ai-labs/source-sage-mcp-server.git
   

2. 创建功能分支

   git checkout -b feature/your-feature-name
   

3. 提交代码

   git add .
   git commit -m "feat: 添加新功能"
   git push origin feature/your-feature-name
   

4. 创建 Pull Request

📄 许可证

本项目遵循 MIT 协议。
许可证内容请参阅 LICENSE 文件。

感谢您使用 SourceSageServer！如需帮助或反馈，请访问 https://github.com/sunwood-ai-labs/source-sage-mcp-server。