🎯 主な特徴

📖 产品定位

SourceSage MCP是一个专门用于项目目录结构可视化和文档化的MCP服务器，旨在帮助开发者更好地理解和维护项目结构。

🎯 核心功能

• 📁 目录结构的Markdown格式输出
• 🎨 美观的树形结构显示（ASCII art）
• 📝 文件内容的自动文档化（支持语言特定的语法高亮）
• 🔍 灵活的排除模式（通过.SourceSageignore文件）
• 🚀 基于ES2022和Node16模块系统的最新实现
• 💫 严格的类型检查确保高可靠性

🛠️ 适用场景

• 项目文档生成
• 代码库结构可视化
• 新成员项目熟悉
• 项目结构审计
• 自动化文档生成

🎮 工具列表

generate_structure

生成项目目录结构并创建包含文件详细内容的文档。

interface GenerateStructureArgs {
  path: string; // 必须，生成结构的目录路径（绝对路径）
  ignorePath?: string; // 可选，.SourceSageignore文件路径（绝对路径）
}

❓ 常见问题

1. 如何自定义排除模式？

2. 在项目根目录创建.SourceSageignore文件并添加排除模式

3. 支持哪些文件类型的语法高亮？

4. 支持大多数常见编程语言的语法高亮

5. 如何处理大型项目？

6. 使用异步处理和glob包进行高效文件遍历

⚙️ 使用教程

安装依赖

确保已安装Node.js（推荐v16+）和npm

安装方式

通过npm安装

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

从源码构建

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

基本配置

1. 在MCP配置文件中添加：

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

调试方式

开发服务器启动

npm run inspector

常用npm脚本

• npm run build: 编译TypeScript并设置执行权限
• npm run watch: 开发时自动编译
• npm run inspector: 启动MCP检查器

许可证

该项目遵循 MIT 开源许可条款。