🌟 SourceSage MCP
📖 概要
SourceSage将项目目录结构以美观的标记形式可视化MCP服务器。TypeScript中描述的场景，使用以下步骤创建明细表，以便在概念设计中分析体量的体积。同时，自动记录各文件的内容，容易掌握项目的全貌。
🎯 主要特征
- 📁 以目录结构标记的形式输出
- 🎨 美丽的树结构表示（ASCII art）
- 📝 自动记录文件内容（带语言语法突出显示）
- 🔍 灵活的排除模式（.SourceSageignore）
- 🚀 ES2022打开Node16模块系统的最新实现
- 💫 通过严格的模具检查获得高可靠性
🛠️ 技术栈
- 🔷 TypeScript (ES2022目标）
- 📦 模型上下文协议SDK（v0.6.0）
- 🌐 Node.js (Node16模块系统）
- 📚 glob (v11.0.0) - 文件模式匹配
- 🎭 ignore (v6.0.2) - 灵活的文件排除功能
📂 项目结构
source-sage/
├── assets/
│ └── header.svg # プロジェクトヘッダー画像
├── src/
│ └── index.ts # メインサーバー実装
├── build/ # コンパイル済みJavaScriptファイル
├── .gitignore # Gitの除外設定
├── .SourceSageignore # SourceSage固有の除外設定
├── package.json # プロジェクト設定・依存関係
├── README.md # プロジェクトドキュメント
└── tsconfig.json # TypeScript設定⚙️ TypeScript设定
{
"compilerOptions": {
"target": "ES2022", // 最新のECMAScript機能を活用
"module": "Node16", // Node.js 16の最新モジュールシステムを使用
"moduleResolution": "Node16",
"outDir": "./build", // コンパイル済みファイルの出力先
"rootDir": "./src", // ソースファイルのルートディレクトリ
"strict": true, // 厳格な型チェックを有効化
"esModuleInterop": true, // CommonJSモジュールとの相互運用性を確保
"skipLibCheck": true, // 型定義ファイルのチェックをスキップ
"forceConsistentCasingInFileNames": true // ファイル名の大文字小文字を厳格に管理
}
}⚙️ 安装
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🔧 使用方法
MCP设置为服务器
- MCP在配置文件中添加：
{
"mcpServers": {
"source-sage": {
"command": "node",
"args": ["C:/path/to/source-sage/build/index.js"]
}
}
}🎮 可用工具
发电机结构
生成项目目录结构，并创建包含文件内容的详细文档。
interface GenerateStructureArgs {
// 構造を生成するディレクトリのパス（必須）
// 必ず絶対パスで指定してください
path: string;
// .SourceSageignoreファイルのパス（オプション）
// 指定する場合は絶対パスで指定してください
ignorePath?: string;
}使用例
// 絶対パスでの使用（推奨）
const result = await mcpClient.callTool('source-sage', 'generate_structure', {
path: 'C:/Users/your-name/path/to/your-project',
ignorePath: 'C:/Users/your-name/path/to/your-project/.SourceSageignore'
});输出示例
实际项目结构输出示例：
# 📁 Project: source-sage
## 🌳 ディレクトリ構造
OS: win32
Directory: C:\Users\your-name\source-sage
└─ source-sage/
├─ src/
│ └─ index.ts # MCPサーバーの主要な実装
├─ package.json # プロジェクトの依存関係と設定
├─ README.md # プロジェクトの詳細な説明
└─ tsconfig.json # TypeScriptのコンパイル設定此输出包含以下信息：
- 📁 项目名称和OS信息
- 🌳 目录树结构
- 📝 每个文件的角色和说明
- 🔍 .SourceSageignore排除不需要的文件
📝 .SourceSageignore配置
项目根目录.SourceSageignore创建文件，记述想要排除的模式。默认情况下包含以下排除模式：
# バージョン管理システム関連
.git
.gitignore
# キャッシュファイル
__pycache__
.pytest_cache
**/__pycache__/**
*.pyc
# ビルド・配布関連
build
dist
*.egg-info
# 一時ファイル・出力
output
output.md
test_output
.SourceSageAssets
.SourceSageAssetsDemo
# アセット
*.png
*.svg
assets
# その他
LICENSE
example
folder
package-lock.json🔄 出力例
# 📁 Project: my-project
## 🌳 ディレクトリ構造
OS: win32
Directory: C:\path\to\my-project
└─ my-project/
├─ src/
│ ├─ index.ts
│ └─ utils/
│ └─ helper.ts
└─ package.json
## 📄 ファイル内容
### 📝 `src/index.ts`
**Type**: TypeScript Source File
👨💻 开发人员信息
主要实施详细信息
- 服务器类:
SourceSageServer类别MCP提供服务器核心功能 - 建树:
- buildTree方法递归分析目录结构 - 正确排序和显示目录和文件
- 文件筛选:
- ignore使用软件包实现灵活的文件排除 - 支持丰富的默认排除模式和自定义设置
- 内容生成:
- 适合文件类型的语法高亮显示 - 提供基于文件类型的附加信息
- 异步处理:
- glob使用包高效文件扫描 - 异步支持大型项目
开发环境设置
# リポジトリのクローン
git clone https://github.com/sunwood-ai-labs/source-sage-mcp-server.git
# 依存関係のインストール
npm install
# 開発用ビルド
npm run build
# 開発サーバーの起動
npm run inspector可用的npm脚本，脚本
npm run build: TypeScript编译和配置执行权限npm run prepare：安装时自动构建npm run watch：开发时的自动编译npm run inspector: MCP启动检查器
🤝 分发
- 分叉此存储库
- 创建新分支（
git checkout -b feature/amazing-feature) - 提交更改（
git commit -m '✨ feat: 素晴らしい機能を追加') - 推到分支（
git push origin feature/amazing-feature) - 创建拉式请求
📄 许可证
MIT License - 了解更多信息 许可证 请参见文件。
🔗 相关链接
👥 维护者
- Sunwood人工智能实验室团队
______________________________________________________________________
Made with ❤️ by Sunwood AI Labs