微信扫一扫article
README
🚀 Lucidity - 模型上下文协议（MCP）服务器
Lucidity是一款开源工具，旨在助力开发者与AI助手更高效地协作。它通过智能提示分析，有效提升AI生成代码的质量，为开发工作带来便利与保障。
🚀 快速开始
安装完成后，你可以按以下步骤操作：
- 启动Lucidity服务器：
python -m lucidity.server --transport sse --port 8080
- 使用AI助手连接并查询代码质量：
# 示例查询：分析最近的git更改
/analyze_changes?workspace_root=/path/to/repo
✨ 主要特性
- 与MCP兼容：支持通过MCP协议进行交互。
- 多语言支持：能够分析多种编程语言的代码质量。
- 实时反馈：快速提供代码优化建议和潜在问题检测。
- 可扩展架构：便于集成到各种开发工作流程中。
- 易于使用：通过简单的命令行即可操作。
📦 安装指南
先决条件
- Python 3.9+：确保你使用的是兼容版本。
- UV：已安装并配置好（用于依赖管理）。
- Git：用于代码仓库操作（可选但推荐）。
安装步骤
- 克隆仓库：
git clone https://github.com/hyperb1iss/lucidity.git
cd lucidity
- 使用UV安装依赖：
uv install
- 启动服务器：
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能够检测以下问题：
- 代码质量问题：
- 重复逻辑。
- 不佳的编程习惯。
- 可读性低的代码结构。
- 安全风险：
- 明文存储敏感信息。
- 潜在的安全漏洞。
- 权限管理不善。
- 测试覆盖率：
- 未覆盖的功能点。
- 测试用例不足。
- 测试与代码不匹配。
- 性能优化建议：
- 不当的资源使用。
- 可能的性能瓶颈。
- 优化空间识别。
- 文档完整性：
- 缺失的注释。
- 文档与实现不一致。
- 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