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 서버입니다.

특징

코드 수집 도구

  • 전체 프로젝트에서 코드 수집
  • 특정 디렉토리나 파일에서 코드 수집
  • 여러 경로에서 코드 수집
  • 구문 강조 표시가 있는 마크다운 출력
  • 목차 생성
  • 다양한 프로그래밍 언어 지원

프로젝트 구조 보고 도구

  • 프로젝트 구조 및 지표 분석
  • 마크다운 형식으로 자세한 보고서 생성
  • 파일 크기 및 복잡성 분석
  • 트리 기반 시각화
  • 코드 구성에 대한 권장 사항
  • 사용자 정의 가능한 무시 패턴

빠른 개요

지엑스피1

종속성을 수동으로 설치하거나 구성할 필요가 없습니다. 이 도구는 코드 분석 및 문서화에 필요한 모든 것을 자동으로 설정합니다.

설치

컴퓨터에 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 라이선스. 자세한 내용은 라이선스 파일을 참조하세요.

You must be authenticated.

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

파일과 디렉토리의 코드를 수집하여 단일 마크다운 문서로 만드는 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