article
README
🚀 MCP 服务器 NeuroLORA 说明文档
本项目的 MCP 服务器 NeuroLORA 支持 MCP 协议,通过标准输入输出传输协议运行,还提供开发者模式及清晰的文件存储结构,能有效提升开发与使用体验。
🚀 快速开始
安装步骤
- 克隆仓库。
- 创建并激活虚拟环境:
python -m venv .venv
source .venv/bin/activate # Unix 系统
# 或者
.venv\Scripts\activate # Windows 系统
- 安装开发依赖:
pip install -e ".[dev]"
- 启动服务器:
- 标准模式(MCP 服务,标准输入输出传输):
python -m mcp_server_neurolorap
- 开发者模式(JSON-RPC 终端界面):
python -m mcp_server_neurolorap --dev
✨ 主要特性
- MCP 协议支持:通过标准输入输出传输协议运行。
- 开发者模式:提供 JSON-RPC 终端接口。
- 文件存储结构:
- 在项目根目录下创建
.neurolora符号链接,指向文档目录。 - 支持多个项目,确保文件组织一致性和快速访问。
- 在项目根目录下创建
📚 详细文档
测试信息
- 自动化测试套件包含超过 80% 的代码覆盖率。
- 在 Python 3.10、3.11 和 3.12 上运行测试。
- 持续集成通过 GitHub Actions 实现。
- 定期进行安全扫描和依赖检查。
代码质量
项目采用以下工具确保代码质量:
# 格式化代码
black .
# 排序导入
isort .
# 编码检查
flake8 .
# 类型检查
mypy src tests
# 安全检查
bandit -r src/
safety check
CI/CD 流水线
项目使用 GitHub Actions 进行持续集成和部署:
- 在 Python 3.10、3.11 和 3.12 上运行测试。
- 检查代码格式和风格。
- 执行类型检查。
- 运行安全扫描。
- 生成覆盖率报告。
- 构建并验证包。
- 上载测试 artifacts。
🤝 贡献指南
欢迎贡献!请查阅 CONTRIBUTING.md 获取详细说明。
📄 许可证
本项目采用 MIT 许可证,具体内容见 LICENSE 文件。
Scan to join WeChat group