Directory Visualization

🚀 SourceSageServer

SourceSageServer is a server-side core component implemented based on the MCP protocol. It can parse and process the file system structure, generate a directory tree view, and provide detailed file information.

🚀 Quick Start

After installation, you can start the server with the following commands:

npm run build
npm start

✨ Features

• Automatically build directory tree: Recursively scan the specified directory and generate a structured directory tree.
• File filtering function: Use preset ignore rules or custom filtering logic to exclude unnecessary files and directories.
• Content display: Support syntax highlighting for multiple file types and provide additional information related to the file type.

📦 Installation

Installation Steps

1. Clone the repository to your local machine:

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

2. Navigate to the project directory and install the dependencies:

cd source-sage-mcp-server
npm install

📚 Documentation

Project Architecture

The project mainly consists of the following core components:

• SourceSageServer: The concrete implementation class of the MCP protocol.
• DirectoryScanner: A directory scanner responsible for recursively traversing the directory structure.
• FileFilter: A file filtering module that supports multiple filtering rules.
• ContentGenerator: A content generator that provides formatted output of file content.

Code Example

import { SourceSageServer } from './SourceSageServer';

// Initialize the server instance
const server = new SourceSageServer({
    root: '/path/to/root',
    ignorePatterns: ['.git', 'node_modules']
});

// Start the service
server.start(8080);

💪 Contribution Guide

1. Clone the repository

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

2. Create a feature branch

git checkout -b feature/your-feature-name

3. Commit your code

git add .
git commit -m 'feat: Add a new feature'
git push origin feature/your-feature-name

4. Submit a pull request

📄 License

This project is licensed under the MIT License. Please refer to the LICENSE file for details.

🔗 Project Links

• npm Package
• GitHub Repository

👨‍💻 Maintenance Team

• Sunwood AI Labs Team

Passionately crafted by Sunwood AI Labs