Lucidity MCP

🚀 Lucidity - 模型上下文協議（MCP）服務器

Lucidity是一款開源工具，旨在助力開發者與AI助手更高效地協作。它通過智能提示分析，有效提升AI生成代碼的質量，為開發工作帶來便利與保障。

🚀 快速開始

安裝完成後，你可以按以下步驟操作：

1. 啟動Lucidity服務器：

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

2. 使用AI助手連接並查詢代碼質量：

# 示例查詢：分析最近的git更改
/analyze_changes?workspace_root=/path/to/repo

✨ 主要特性

• 與MCP兼容：支持通過MCP協議進行交互。
• 多語言支持：能夠分析多種編程語言的代碼質量。
• 即時反饋：快速提供代碼優化建議和潛在問題檢測。
• 可擴展架構：便於集成到各種開發工作流程中。
• 易於使用：通過簡單的命令行即可操作。

📦 安裝指南

先決條件

• Python 3.9+：確保你使用的是兼容版本。
• UV：已安裝並配置好（用於依賴管理）。
• Git：用於代碼倉庫操作（可選但推薦）。

安裝步驟

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

💻 使用示例

基礎用法

# 示例查詢：分析最近的git更改
/analyze_changes?workspace_root=/path/to/repo

高級用法

# 分析指定文件的代碼質量
/analyze_changes?workspace_root=/path/to/repo&path=/path/to/file

📚 詳細文檔

分析維度

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

貢獻指南

歡迎貢獻！請參考CONTRIBUTING.md瞭解如何參與開發。

許可證

本項目採用MIT License。請查看LICENSE獲取詳細信息。

聯繫方式

如需反饋或問題，請聯繫[email] 或在GitHub上提交issue。

項目地址

https://github.com/hyperb1iss/lucidity

文檔地址

https://lucidity.readthedocs.io