Lucidity MCP

🚀 Lucidity - モデルコンテキストプロトコル (MCP) サーバー

このプロジェクトは、開発者とAIアシスタントがより効果的に協力できるように設計されたオープンソースツールです。智能的なプロンプト分析を通じて、AIが生成するコードの品質を向上させます。

🚀 クイックスタート

インストールが完了したら、以下のことができます。

1. Lucidityサーバーを起動します。

python -m lucidity.server --transport sse --port 8080

2. AIアシスタントを使用して接続し、コード品質を照会します。

# 例の照会：最近のgitの変更を分析する
/analyze_changes?workspace_root=/path/to/repo

✨ 主な機能

• MCP互換性：MCPプロトコルを介したやり取りをサポートします。
• 多言語対応：複数のプログラミング言語のコード品質を分析できます。
• リアルタイムフィードバック：迅速にコードの最適化提案と潜在的な問題の検出を提供します。
• 拡張可能なアーキテクチャ：様々な開発ワークフローに簡単に統合できます。
• 使いやすさ：簡単なコマンドラインで操作できます。

📦 インストール

1. リポジトリをクローンします。

git clone https://github.com/hyperb1iss/lucidity.git
cd lucidity

2. UVを使用して依存関係をインストールします。

uv install

3. サーバーを起動します。

python -m lucidity.server --host 0.0.0.0 --port 8080

前提条件

• Python 3.9+：互換性のあるバージョンを使用していることを確認してください。
• UV：インストールされ、設定されている必要があります（依存関係管理に使用）。
• Git：コードリポジトリの操作に使用します（オプションですが推奨）。

📚 ドキュメント

分析の次元

Lucidityは以下の問題を検出できます。

1. コード品質の問題：
   • 重複するロジック
   • 不適切なプログラミング習慣
   • 読みにくいコード構造
2. セキュリティリスク：
   • 平文での機密情報の保存
   • 潜在的なセキュリティホール
   • 権限管理の不備
3. テストのカバレッジ：
   • カバーされていない機能ポイント
   • テストケースの不足
   • テストとコードの不一致
4. パフォーマンスの最適化提案：
   • 不適切なリソースの使用
   • 潜在的なパフォーマンスのボトルネック
   • 最適化の余地の特定
5. ドキュメントの完全性：
   • 欠落しているコメント
   • ドキュメントと実装の不一致
   • APIドキュメントの不足

例の照会

以下は、AIアシスタントで試すことができる照会の例です。

• "私の最近のgitコミットのコード品質を分析して"
• "私のJavaScriptの変更にセキュリティホールがないか確認して"
• "私のPythonコードがベストプラクティスに従っていることを確認して"
• "私の最近のコードのパフォーマンス問題を特定して"

利用可能なMCPツール

ツールのリスト

• analyze_changes：gitの変更を分析する準備をします。
  • パラメータ：
    • workspace_root：ワークスペースまたはgitリポジトリのルートディレクトリ
    • path：分析する特定のファイルのパス（オプション）

開発情報

Lucidityは、依存関係管理と開発フローにUVを使用しています。UVは、高速で信頼性の高いPythonパッケージマネージャーと解決ツールです。

# 依存関係を更新する：
uv sync

# テストを実行する：
pytest

# コードチェックを実行する：
ruff check .

# 型チェックを実行する：
mypy .

ログの動作

Lucidityは、トランスポート方式に応じてログを処理します。

• SSEトランスポート：完全なコンソールログを有効にします。
• Stdioトランスポートで--log-fileが指定されている場合：すべてのログをファイルに書き込み、コンソール出力を無効にします。
• Stdioトランスポートで--log-fileが指定されていない場合：エラーログのみを表示します。

コマンドラインオプション

usage: lucidity.server [-h] [--debug] [--host HOST] [--port PORT]

オプションの引数：
  -h, --help      ヘルプメッセージを表示して終了します。
  -d, --debug     デバッグモードを有効にします。
  --host HOST     サーバーがバインドするホストアドレスを指定します。デフォルトは127.0.0.1です。
  --port PORT     サーバーが使用するポートを指定します。デフォルトは8080です。

📄 ライセンス

このプロジェクトはMITライセンスの下で提供されています。詳細については、LICENSEを参照してください。

連絡先

フィードバックや問題がある場合は、[email]に連絡するか、GitHubでissueを提出してください。

プロジェクトのURL

https://github.com/hyperb1iss/lucidity

ドキュメントのURL

https://lucidity.readthedocs.io