Source Sage MCP Server

🚀 源木 Sage MCP サーバ

このサーバはMCPサーバの機能を提供し、ディレクトリ構造の解析やファイルのフィルタリングなどの機能があります。

🚀 クイックスタート

このセクションでは、源木 Sage MCP サーバの基本的な使い方を説明します。

📦 インストール

インストール手順

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

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

2. ディレクトリに移動する

   cd source-sage-mcp-server
   

3. 依存関係をインストールする

   npm install
   

4. プロジェクトをビルドする

   npm run build
   

5. 開発サーバを起動する

   npm run inspector
   

📚 ドキュメント

設定ガイド

無視ファイルの設定

プロジェクトのルートディレクトリで .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

使用ガイド

主要機能

• サーバクラス：SourceSageServer クラスはMCPサーバの主要機能を提供します。
• ディレクトリツリーの構築：
  • buildTree メソッドを使用してディレクトリ構造を再帰的に解析します。
  • ディレクトリとファイルを適切に並べ替えて良好な表示效果を実現します。
• ファイルフィルタリング：
  • ignore パッケージを使用して柔軟なファイル除外機能を実現します。
  • 豊富なデフォルト除外パターンとカスタム設定をサポートします。
• コンテンツ生成：
  • ファイルタイプに応じて適切な構文ハイライトを提供します。
  • ファイルの種類に応じて追加情報を提供します。
• 非同期処理：
  • glob パッケージを使用して効率的なファイル走査を実現します。
  • 非同期処理により大規模プロジェクトをサポートします。

開発サーバの起動

npm run inspector

開発者ガイド

主な実装詳細

• サーバクラス：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

貢献ガイド

コード提出規範

1. リポジトリをフォークする

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

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

   git checkout -b feature/your-feature-name
   

3. コードを提出する

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

4. Pull Requestを作成する

📄 ライセンス

このプロジェクトはMITライセンスに従います。
ライセンスの内容は LICENSE ファイルを参照してください。

SourceSageServerをご利用いただき、ありがとうございます！ヘルプやフィードバックが必要な場合は、https://github.com/sunwood-ai-labs/source-sage-mcp-server をご覧ください。