Quack MCP Server

🚀 鴨鳴き（Quack）ガイド

鴨鳴き（Quack）は、モデルコンテキストプロトコル（MCP）に基づいて構築されたPythonコード分析サーバーです。複数のコード分析ツールをサポートし、C言語拡張（C Extension）を通じてVisual Studio Codeと統合され、Python開発にリアルタイムのフィードバックを提供します。

🚀 クイックスタート

サーバーの起動

python3 quack.py --stdio

デフォルトでは、サーバーはローカルIPアドレスの8000ポートにバインドされます。他のホストまたはポートを指定するには、以下のコマンドを使用します。

python3 quack.py --stdio --host <ホスト> --port <ポート>

使用例コード

以下は、様々な問題を含むサンプルコードで、サーバーの機能をテストするために使用できます。

# 誤った使用例：
unused_var = 42  # 未使用の変数
x = 10  # 単一文字の変数名
print("Hello, World!")  # 改行がない

# 型エラーの例：
def add(a: int, b: int) -> int:
    return a + b

result = add("5", 10)  # 型エラー：文字列と整数の加算

このコードをC言語拡張に貼り付けると、Quackサーバーが自動的に問題を検出して報告します。

✨ 主な機能

Quackは、以下のような複数のコード分析ツールをサポートしています。

• Pylint：コードスタイルと品質の問題を検出します。
• Mypy：静的型チェックを行います。

📦 インストール

依存関係のインストール

Quackを実行する前に、以下のツールがインストールされていることを確認してください。

• Python 3.8以上
• Docker（SSEモードのみ）
• pip

次に、必要なPythonパッケージをインストールします。

pip install quack

鴨鳴きサーバーの起動

鴨鳴きサーバーには、標準入出力モードとストリーミング交換拡張モードの2つの実行モードがあります。

標準入出力モード

Pythonスクリプトを直接実行します。

python3 -m quack.server --stdio

デフォルトでは、サーバーはローカルIPアドレスの8000ポートを監視します。異なるホストまたはポートを指定するには、以下のコマンドを使用します。

python3 -m quack.server --stdio --host <ホスト> --port <ポート>

ストリーミング交換拡張モード

Dockerを使用して実行します。

docker run -p 8000:8000 quack/mcp-server

🔧 設定と統合

Quackサーバーの設定

設定ファイルquack_server_config.jsonを作成し、以下の内容を追加します。

{
    "name": "Python Linter",
    "command": "python3 -m quack.server --stdio",
    "args": [],
    "stdinHandler": {
        "type": "stdio"
    },
    "schemes": ["file"],
    "language": "python",
    "dllLoadMessage": ""
}

この設定ファイルをVisual Studio Codeのsettings.jsonに追加します。

{
    "extensions.csharpEnableCodeLens": false,
    "extensions.csharpShowSnippetsOnHover": false,
    "extensions.pythonVSQuackServer": "/path/to/quack_server_config.json"
}

💻 使用例

標準入出力モード

ターミナルで以下のコマンドを実行します。

python3 -m quack.server --stdio

次に、以下のコマンドを使用してサーバーと対話します。

# 新しいジョブを送信
curl -X POST http://localhost:8000/queue \
     -H "Content-Type: application/json" \
     -d '{"tool":"pylint","content":"print(\"Hello, World!\")"}'

# ジョブの状態を確認
curl http://localhost:8000/queue/<JOB_ID>

# 分析結果を取得
curl http://localhost:8000/results/<RESULT_ID>

ストリーミング交換拡張モード

以下のコマンドでアクセスします。

http://localhost:8000/sse

📚 ドキュメント

詳細な情報については、公式ドキュメントを参照してください。