Source Sage MCP Server

🚀 Source Wood Sage MCP Server

The Source Wood Sage MCP Server offers a robust solution for managing and processing files, with features like efficient directory tree building, flexible file filtering, and content generation.

🚀 Quick Start

The Source Wood Sage MCP Server provides a set of powerful features for file management and processing. To get started quickly, follow the steps below.

✨ Features

• Server Class: The SourceSageServer class offers the core functionality of the MCP server.
• Directory Tree Building:
  • Recursively parse the directory structure using the buildTree method.
  • Sort directories and files appropriately for a good display effect.
• File Filtering:
  • Implement flexible file exclusion using the ignore package.
  • Support a wide range of default exclusion patterns and custom settings.
• Content Generation:
  • Provide appropriate syntax highlighting based on file types.
  • Offer additional information according to file categories.
• Async Processing:
  • Achieve efficient file traversal using the glob package.
  • Support large - scale projects through asynchronous processing.

📦 Installation

Installation Steps

1. Clone the repository

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

2. Navigate to the directory

   cd source-sage-mcp-server
   

3. Install dependencies

   npm install
   

4. Build the project

   npm run build
   

5. Start the development server

   npm run inspector
   

📚 Documentation

Configuration Guide

Ignore File Configuration

Create or modify the .SourceSageignore file in the project root directory and add the files and directories to be ignored:

# Version control related
.git
.gitignore

# Cache files
__pycache__
.pytest_cache
**/__pycache__/**
*.pyc

# Build and release related
build
dist
*.egg-info

# Temporary files and output
output
output.md
test_output
.SourceSageAssets
.SourceSageAssetsDemo

# Resource files
*.png
*.svg
assets

# Others
LICENSE
example
folder
package-lock.json

Usage Guide

Core Features

• Server Class: The SourceSageServer class provides the core functionality of the MCP server.
• Directory Tree Building:
  • Use the buildTree method to recursively parse the directory structure.
  • Sort directories and files properly for a good display.
• File Filtering:
  • Use the ignore package to achieve flexible file exclusion.
  • Support a variety of default exclusion patterns and custom settings.
• Content Generation:
  • Provide appropriate syntax highlighting according to file types.
  • Offer additional information based on file categories.
• Async Processing:
  • Use the glob package for efficient file traversal.
  • Support large - scale projects through asynchronous processing.

Starting the Development Server

npm run inspector

Developer Guide

Main Implementation Details

• Server Class: The SourceSageServer class provides the core functionality of the MCP server.
• Tree Building:
  • Use the buildTree method to recursively parse the directory structure.
  • Sort directories and files appropriately for a good display effect.
• File Filtering:
  • Use the ignore package to implement flexible file exclusion.
  • Support a wide range of default exclusion patterns and custom settings.
• Content Generation:
  • Provide appropriate syntax highlighting based on file types.
  • Offer additional information according to file categories.
• Async Processing:
  • Use the glob package for efficient file traversal.
  • Support large - scale projects through asynchronous processing.

Setting up the Development Environment

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

# Install dependencies
npm install

# Development build
npm run build

# Start the development server
npm run inspector

Contribution Guide

Code Submission Guidelines

1. Fork the repository

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

2. Create a feature branch

   git checkout -b feature/your-feature-name
   

3. Submit code

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

4. Create a Pull Request

📄 License

This project is licensed under the MIT License.
Please refer to the LICENSE file for the full license text.

Thank you for using SourceSageServer! For help or feedback, please visit https://github.com/sunwood-ai-labs/source-sage-mcp-server.