Directory Visualization

🚀 SourceSageServer

SourceSageServer 是一個基於 MCP 協議實現的服務器端核心組件，它能夠解析和處理文件系統結構，生成目錄樹視圖，並提供詳細的文件信息，為文件管理和查看帶來便利。

🚀 快速開始

完成安裝後，可以通過以下命令啟動服務器：

npm run build
npm start

✨ 主要特性

• 自動構建目錄樹：遞歸掃描指定目錄並生成結構化的目錄樹。
• 文件過濾功能：使用預設的忽略規則或自定義過濾邏輯，排除不必要的文件和目錄。
• 內容展示：支持多種文件類型的語法高亮顯示，並提供文件類型相關的附加信息。

📦 安裝指南

安裝步驟

1. 克隆倉庫到本地：

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

2. 進入項目目錄並安裝依賴：

cd source-sage-mcp-server
npm install

💻 使用示例

基礎用法

import { SourceSageServer } from './SourceSageServer';

// 初始化服務器實例
const server = new SourceSageServer({
    root: '/path/to/root',
    ignorePatterns: ['.git', 'node_modules']
});

// 啟動服務
server.start(8080);

🔧 技術細節

項目架構

項目主要由以下幾個核心部分組成：

• SourceSageServer：MCP 協議的具體實現類
• DirectoryScanner：目錄掃描器，負責遞歸遍歷目錄結構
• FileFilter：文件過濾模塊，支持多種過濾規則
• ContentGenerator：內容生成器，提供文件內容的格式化輸出

🤝 貢獻指南

1. 克隆倉庫

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

2. 創建功能分支

git checkout -b feature/your-feature-name

3. 提交代碼

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

4. 發起合併請求

📄 許可證

本項目遵循 MIT 協議，具體內容請參考 LICENSE 文件。

🔗 項目鏈接

• npm包
• GitHub倉庫

👨‍💻 維護團隊

• Sunwood AI Labs 團隊

由 Sunwood AI Labs 熱心打造