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 热心打造