Directory Visualization

🚀 SourceSageServer

SourceSageServerは、MCPプロトコルに基づいて実装されたサーバーサイドのコアコンポーネントです。これは、ファイルシステム構造を解析および処理し、ディレクトリツリービューを生成し、詳細なファイル情報を提供することができます。

🚀 クイックスタート

SourceSageServerは、MCPプロトコルに基づいて実装されたサーバーサイドのコアコンポーネントです。これは、ファイルシステム構造を解析および処理し、ディレクトリツリービューを生成し、詳細なファイル情報を提供することができます。

📦 インストール

インストール手順

1. リポジトリをローカルにクローンします:

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

2. プロジェクトディレクトリに移動し、依存関係をインストールします:

cd source-sage-mcp-server
npm install

クイックスタート

インストールが完了したら、以下のコマンドでサーバーを起動できます:

npm run build
npm start

✨ 主な機能

• 自動ディレクトリツリー構築: 指定されたディレクトリを再帰的にスキャンし、構造化されたディレクトリツリーを生成します。
• ファイルフィルタリング機能: 事前設定された無視規則またはカスタムフィルタリングロジックを使用して、不要なファイルやディレクトリを除外します。
• 内容表示: 複数のファイルタイプの構文ハイライト表示をサポートし、ファイルタイプに関連する追加情報を提供します。

📚 ドキュメント

プロジェクトアーキテクチャ

プロジェクトは主に以下のいくつかのコア部分で構成されています:

• SourceSageServer: MCPプロトコルの具体的な実装クラス
• DirectoryScanner: ディレクトリを再帰的に走査するディレクトリスキャナー
• FileFilter: 複数のフィルタリングルールをサポートするファイルフィルタリングモジュール
• ContentGenerator: ファイル内容の書式付き出力を提供する内容生成器

コード例

import { SourceSageServer } from './SourceSageServer';

// サーバーインスタンスを初期化します
const server = new SourceSageServer({
    root: '/path/to/root',
    ignorePatterns: ['.git', 'node_modules']
});

// サービスを起動します
server.start(8080);

🤝 貢献ガイド

1. リポジトリをクローンする

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

2. 機能ブランチを作成する

git checkout -b feature/your-feature-name

3. コードをコミットする

git add .
git commit -m 'feat: 新機能を追加する'
git push origin feature/your-feature-name

4. マージリクエストを送信する

📄 ライセンス

このプロジェクトはMITライセンスに準拠しており、詳細については LICENSE ファイルを参照してください。

🔗 プロジェクトリンク

• npmパッケージ
• GitHubリポジトリ

👨‍💻 メンテナンスチーム

• Sunwood AI Labsチーム

Sunwood AI Labsによって愛情を込めて作成されました