Source Sage MCP Server

🚀 源木 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。