SourceSage

Provides a Markdown-structured visualization of a project's directory tree with automatic file documentation and optional ignore rules.

typescript

5

GitHub Stars

typescript

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "sunwood-ai-labs-source-sage-mcp-server": {
      "command": "node",
      "args": [
        "C:/path/to/source-sage/build/index.js"
      ]
    }
  }
}

SourceSage MCP visualizes a project's directory structure in beautiful Markdown, automatically documents file contents, and supports flexible ignore rules to help you understand large codebases at a glance.

How to use

Set up a local MCP client to connect to the SourceSage MCP server. You will run SourceSage as a local process and command the client to generate a structured, searchable document of your project. The server will produce a Markdown-based tree view, with syntax-highlighted code blocks for each file and optional exclusion patterns to hide noise.

How to install

Prerequisites you need before installing:
- Node.js (Node16 or compatible). 
- npm (comes with Node.js).
- Basic knowledge of your project path and a place to store generated documents.

Install from binary or build from source

npm install -g @sunwood-ai-labs/source-sage-mcp-server

or, if you prefer building from source:

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

Configuration and usage with MCP client

Configure your MCP client to run SourceSage as a local (stdio) server. The following configuration starts the server by invoking Node on the built entry point. Adjust the path to your build output as needed.

{
  "mcpServers": {
    "source_sage": {
      "type": "stdio",
      "name": "source_sage",
      "command": "node",
      "args": ["C:/path/to/source-sage/build/index.js"]
    }
  }
}

Usage pattern with the MCP client

Start SourceSage as a local MCP server using your preferred method (the stdio configuration above). 2) In your MCP client, request a structure generation for your project directory. 3) The server will output a Markdown document showing the directory tree and file details, applying any ignore rules you specify.

Available tools

generate_structure

Generates the project directory structure as a Markdown document, including highlighted contents of files and optional exclusions based on ignore rules.