MCP Code Checker

🚀 MCPコード規範チェックサーバー

MCPコード規範チェックサーバーは、コード規範のチェックとテストを実行するためのツールです。以下の機能をサポートしています。

1. Pylintチェックの実行：プロジェクトコードの静的解析を行い、コード品質の問題、スタイルの問題、潜在的なバグを識別します。
2. Pytestテストの実行：プロジェクト内の単体テストを実行し、テスト結果を報告します。
3. 総合チェック：PylintチェックとPytestテストを同時に実行し、総合結果を返します。

🚀 クイックスタート

MCPコード規範チェックサーバーを使用するには、まずサーバーをインストールして起動する必要があります。以下に手順を示します。

✨ 主な機能

• Pylintチェックの実行：プロジェクトコードの静的解析を行い、コード品質の問題、スタイルの問題、潜在的なバグを識別します。
• Pytestテストの実行：プロジェクト内の単体テストを実行し、テスト結果を報告します。
• 総合チェック：PylintチェックとPytestテストを同時に実行し、総合結果を返します。

📦 インストール

Windowsでの仮想環境の作成とアクティベート

REM リポジトリをクローンする
git clone https://github.com/yourusername/mcp-code-checker.git
cd mcp-code-checker

REM 仮想環境を作成してアクティベートする
python -m venv .venv
.venv\Scripts\activate

REM 依存関係をインストールする
pip install -e .

REM 開発用の依存関係をインストールする
pip install -e ".[dev]"

MCP開発ツールを使用してサーバーを起動する

# PYTHONPATHを設定し、MCP開発ツールを使用してサーバーを起動する
set PYTHONPATH=. && mcp dev src/server.py

💻 使用例

基本的な使用法

1. Pylintチェックの実行

# 追加のパラメータなしで、プロジェクト全体のPylintチェックを実行する
# ここにPylintを実行するコード例があれば記載するが、元のREADMEにはないため省略

2. Pytestテストの実行

# 追加のパラメータなしで、プロジェクト全体のPytestテストを実行する
# ここにPytestを実行するコード例があれば記載するが、元のREADMEにはないため省略

3. 総合チェックの実行

# PylintとPytestのチェックを同時に実行し、総合結果を取得する
# ここに総合チェックを実行するコード例があれば記載するが、元のREADMEにはないため省略

📚 ドキュメント

機能モジュール

1. Pylintチェックの実行

• 機能：プロジェクトコードの静的解析を行い、コード品質の問題を報告します。
• 入力：追加のパラメータなしで、プロジェクト全体のPylintチェックを実行します。
• 出力：Pylintの結果またはLLMによる解釈のヒントを返します。

2. Pytestテストの実行

• 機能：プロジェクト内の単体テストを実行し、テスト結果を報告します。
• 入力：追加のパラメータなしで、プロジェクト全体のPytestテストを実行します。
• 出力：Pytestのテスト結果またはLLMによる解釈のヒントを返します。

3. 総合チェック

• 機能：PylintとPytestのチェックを同時に実行し、総合結果を返します。
• 入力：PylintとPytestの関連パラメータの設定をサポートします。
• 出力：すべてのチェック結果またはLLMによる総合的な解釈のヒントを返します。

セキュリティ機能

• すべてのチェックは指定されたプロジェクトディレクトリ内で実行されます。
• コードの実行はPythonのテストファイル内に厳密に制限されます。
• 結果は人間とLLMが解析しやすい形式で表示されます。

開発に関する説明

環境構成（Windows用）

REM リポジトリをクローンする
git clone https://github.com/yourusername/mcp-code-checker.git
cd mcp-code-checker

REM 仮想環境を作成してアクティベートする
python -m venv .venv
.venv\Scripts\activate

REM 依存関係をインストールする
pip install -e .

REM 開発用の依存関係をインストールする
pip install -e ".[dev]"

MCP開発ツールを使用してサーバーを起動する

# PYTHONPATHを設定し、MCP開発ツールを使用してサーバーを起動する
set PYTHONPATH=. && mcp dev src/server.py

📄 ライセンス

このプロジェクトはMITライセンスの下で公開されています。詳細はLICENSEファイルを参照してください。

⚠️ 重要提示

上記のすべての内容は翻訳結果です。実際のニーズに応じて、設定パラメータとパス情報を調整してください。