hybrid server
The server is able to function both locally and remotely, depending on the configuration or use case.
Integrations
The MCP server integrates with Codecov for tracking code coverage metrics, as evidenced by the Codecov badge in the README.
The MCP server integrates with GitHub for version control, repository hosting, and showing build status through badges.
The MCP server uses GitHub Actions for continuous integration and deployment, running tests across Python versions, checking code formatting, performing type checking, security scans, and generating coverage reports.
MCP サーバー Neurolorap
コード分析とドキュメント化のためのツールを提供する MCP サーバー。
特徴
コード収集ツール
- プロジェクト全体からコードを収集する
- 特定のディレクトリまたはファイルからコードを収集する
- 複数のパスからコードを収集する
- 構文強調表示付きのマークダウン出力
- 目次生成
- 複数のプログラミング言語のサポート
プロジェクト構造レポーターツール
- プロジェクトの構造と指標を分析する
- マークダウン形式で詳細なレポートを生成する
- ファイルサイズと複雑さの分析
- ツリーベースの視覚化
- コード編成に関する推奨事項
- カスタマイズ可能な無視パターン
概要
依存関係を手動でインストールしたり設定したりする必要はありません。ツールがコードの分析とドキュメント化に必要なすべての設定を行います。
インストール
マシンにUV >= 0.4.10 がインストールされている必要があります。
サーバーをインストールして実行するには:
これにより、次の処理が自動的に実行されます。
- 必要な依存関係をすべてインストールする
- Cline統合を構成する
- すぐに使用できるようにサーバーをセットアップする
このサーバーはClineのMCPプロトコルを通じて利用可能になります。あらゆるプロジェクトのコードを分析・文書化するために使用できます。
使用法
開発者モード
サーバーには、直接対話するための JSON-RPC ターミナル インターフェイスを備えた開発者モードが含まれています。
使用可能なコマンド:
help
: 利用可能なコマンドを表示list_tools
: 利用可能な MCP ツールを一覧表示するcollect <path>
: 指定されたパスからコードを収集しますreport [path]
: プロジェクト構造レポートを生成するexit
: 開発者モードを終了する
セッションの例:
MCPツールを通じて
コードコレクション
プロジェクト構造分析
ファイルストレージ
サーバーは、ファイルの保存に構造化されたアプローチを使用します。
- 生成されたすべてのファイルは
~/.mcp-docs/<project-name>/
に保存されます。 - プロジェクトルートにこのディレクトリを指す
.neurolora
シンボリックリンクが作成されます。
これにより、次のことが保証されます。
- クリーンなプロジェクト構造
- 一貫したファイル構成
- 生成されたファイルへの簡単なアクセス
- 複数のプロジェクトのサポート
- 異なるOS環境間での信頼性の高いファイル同期
- IDE やファイルエクスプローラーでのファイルの高速表示
無視パターンのカスタマイズ
無視するファイルをカスタマイズするには、プロジェクト ルートに.neuroloraignore
ファイルを作成します。
.neuroloraignore
ファイルが存在しない場合は、一般的な無視パターンを含むデフォルトのファイルが作成されます。
発達
- リポジトリをクローンする
- 仮想環境を作成してアクティブ化します。
- 開発依存関係をインストールします。
- サーバーを実行します。
テスト
このプロジェクトは、自動テストと継続的インテグレーションを通じて高い品質基準を維持しています。
- 80%以上のコードカバレッジを備えた包括的なテストスイート
- Python 3.10、3.11、3.12 での自動テスト
- GitHub Actionsによる継続的インテグレーション
- 定期的なセキュリティスキャンと依存関係チェック
開発とテストの詳細については、PROJECT_SUMMARY.md を参照してください。
コード品質
このプロジェクトでは、さまざまなツールを通じて高いコード品質基準を維持しています。
これらのチェックはすべて、GitHub Actions を通じてプル リクエストに対して自動的に実行されます。
CI/CDパイプライン
このプロジェクトでは、継続的な統合とデプロイメントに GitHub Actions を使用します。
- Python 3.10、3.11、3.12でテストを実行します
- コードのフォーマットとスタイルをチェックします
- 型チェックを実行する
- セキュリティスキャンを実行する
- カバレッジレポートを生成する
- パッケージをビルドして検証する
- テスト成果物をアップロードする
変更をマージする前にパイプラインを通過する必要があります。
貢献
貢献を歓迎します!ガイドラインについてはCONTRIBUTING.mdをご覧ください。
ライセンス
MITライセンス。詳細はLICENSEファイルを参照してください。
You must be authenticated.
ファイルとディレクトリからコードを 1 つのマークダウン ドキュメントに収集するための MCP サーバー。