MCP Server Neurolorap

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 サーバー。

特徴

コード収集ツール

  • プロジェクト全体からコードを収集する
  • 特定のディレクトリまたはファイルからコードを収集する
  • 複数のパスからコードを収集する
  • 構文強調表示付きのマークダウン出力
  • 目次生成
  • 複数のプログラミング言語のサポート

プロジェクト構造レポーターツール

  • プロジェクトの構造と指標を分析する
  • マークダウン形式で詳細なレポートを生成する
  • ファイルサイズと複雑さの分析
  • ツリーベースの視覚化
  • コード編成に関する推奨事項
  • カスタマイズ可能な無視パターン

概要

# Using uvx (recommended) uvx mcp-server-neurolorap # Or using pip (not recommended) pip install mcp-server-neurolorap

依存関係を手動でインストールしたり設定したりする必要はありません。ツールがコードの分析とドキュメント化に必要なすべての設定を行います。

インストール

マシンにUV >= 0.4.10 がインストールされている必要があります。

サーバーをインストールして実行するには:

# Install using uvx (recommended) uvx mcp-server-neurolorap # Or install using pip (not recommended) pip install mcp-server-neurolorap

これにより、次の処理が自動的に実行されます。

  • 必要な依存関係をすべてインストールする
  • Cline統合を構成する
  • すぐに使用できるようにサーバーをセットアップする

このサーバーはClineのMCPプロトコルを通じて利用可能になります。あらゆるプロジェクトのコードを分析・文書化するために使用できます。

使用法

開発者モード

サーバーには、直接対話するための JSON-RPC ターミナル インターフェイスを備えた開発者モードが含まれています。

# Start the server in developer mode python -m mcp_server_neurolorap --dev

使用可能なコマンド:

  • help : 利用可能なコマンドを表示
  • list_tools : 利用可能な MCP ツールを一覧表示する
  • collect <path> : 指定されたパスからコードを収集します
  • report [path] : プロジェクト構造レポートを生成する
  • exit : 開発者モードを終了する

セッションの例:

> help Available commands: - help: Show this help message - list_tools: List available MCP tools - collect <path>: Collect code from specified path - report [path]: Generate project structure report - exit: Exit the terminal > list_tools ["code_collector", "project_structure_reporter"] > collect src Code collection complete! Output file: code_collection.md > report Project structure report generated: PROJECT_STRUCTURE_REPORT.md > exit Goodbye!

MCPツールを通じて

コードコレクション

from modelcontextprotocol import use_mcp_tool # Collect code from entire project result = use_mcp_tool( "code_collector", { "input": ".", "title": "My Project" } ) # Collect code from specific directory result = use_mcp_tool( "code_collector", { "input": "./src", "title": "Source Code" } ) # Collect code from multiple paths result = use_mcp_tool( "code_collector", { "input": ["./src", "./tests"], "title": "Project Files" } )

プロジェクト構造分析

# Generate project structure report result = use_mcp_tool( "project_structure_reporter", { "output_filename": "PROJECT_STRUCTURE_REPORT.md" } ) # Analyze specific directory with custom ignore patterns result = use_mcp_tool( "project_structure_reporter", { "output_filename": "src_structure.md", "ignore_patterns": ["*.pyc", "__pycache__"] } )

ファイルストレージ

サーバーは、ファイルの保存に構造化されたアプローチを使用します。

  1. 生成されたすべてのファイルは~/.mcp-docs/<project-name>/に保存されます。
  2. プロジェクトルートにこのディレクトリを指す.neuroloraシンボリックリンクが作成されます。

これにより、次のことが保証されます。

  • クリーンなプロジェクト構造
  • 一貫したファイル構成
  • 生成されたファイルへの簡単なアクセス
  • 複数のプロジェクトのサポート
  • 異なるOS環境間での信頼性の高いファイル同期
  • IDE やファイルエクスプローラーでのファイルの高速表示

無視パターンのカスタマイズ

無視するファイルをカスタマイズするには、プロジェクト ルートに.neuroloraignoreファイルを作成します。

# Dependencies node_modules/ venv/ # Build dist/ build/ # Cache __pycache__/ *.pyc # IDE .vscode/ .idea/ # Generated files .neurolora/

.neuroloraignoreファイルが存在しない場合は、一般的な無視パターンを含むデフォルトのファイルが作成されます。

発達

  1. リポジトリをクローンする
  2. 仮想環境を作成してアクティブ化します。
python -m venv .venv source .venv/bin/activate # On Unix # or .venv\Scripts\activate # On Windows
  1. 開発依存関係をインストールします。
pip install -e ".[dev]"
  1. サーバーを実行します。
# Normal mode (MCP server with stdio transport) python -m mcp_server_neurolorap # Developer mode (JSON-RPC terminal interface) python -m mcp_server_neurolorap --dev

テスト

このプロジェクトは、自動テストと継続的インテグレーションを通じて高い品質基準を維持しています。

  • 80%以上のコードカバレッジを備えた包括的なテストスイート
  • Python 3.10、3.11、3.12 での自動テスト
  • GitHub Actionsによる継続的インテグレーション
  • 定期的なセキュリティスキャンと依存関係チェック

開発とテストの詳細については、PROJECT_SUMMARY.md を参照してください。

コード品質

このプロジェクトでは、さまざまなツールを通じて高いコード品質基準を維持しています。

# Format code black . # Sort imports isort . # Lint code flake8 . # Type check mypy src tests # Security check bandit -r src/ safety check

これらのチェックはすべて、GitHub Actions を通じてプル リクエストに対して自動的に実行されます。

CI/CDパイプライン

このプロジェクトでは、継続的な統合とデプロイメントに GitHub Actions を使用します。

  • Python 3.10、3.11、3.12でテストを実行します
  • コードのフォーマットとスタイルをチェックします
  • 型チェックを実行する
  • セキュリティスキャンを実行する
  • カバレッジレポートを生成する
  • パッケージをビルドして検証する
  • テスト成果物をアップロードする

変更をマージする前にパイプラインを通過する必要があります。

貢献

貢献を歓迎します!ガイドラインについてはCONTRIBUTING.mdをご覧ください。

ライセンス

MITライセンス。詳細はLICENSEファイルを参照してください。

You must be authenticated.

A
security – no known vulnerabilities
A
license - permissive license
A
quality - confirmed to work

ファイルとディレクトリからコードを 1 つのマークダウン ドキュメントに収集するための MCP サーバー。

  1. Features
    1. Code Collection Tool
    2. Project Structure Reporter Tool
  2. Quick Overview
    1. Installation
      1. Usage
        1. Developer Mode
        2. Through MCP Tools
        3. File Storage
        4. Customizing Ignore Patterns
      2. Development
        1. Testing
        2. Code Quality
        3. CI/CD Pipeline
      3. Contributing
        1. License
          ID: rg07wseeqe