🚀 MCP 服务器实践规范
MCP 服务器（Model Context Protocol）为开发者提供了一系列工具，可强制执行并自动化多种开发实践，助力提升开发效率与规范性。
🚀 快速开始
MCP 服务器能为开发过程提供诸多便利，可用于分支名称验证、版本管理等常见开发场景。以下是使用前的安装步骤。
📦 安装指南
常规安装
pip install mcp-server-practices
开发环境安装
pip install -e .
使用 UV 工具安装
若你想使用 UV 工具全局安装该包，可按以下步骤操作，避免文件损坏：
选项 1：使用 install_full 脚本
# 清理、构建和一次性安装
./install_full.sh
此脚本将依次执行以下操作：
- 清理之前的构建产物
- 构建包
- 使用 UV 工具安装最新生成的 wheel 文件
选项 2：手动过程
- 首先，构建包的 wheel 文件：
python -m build - 直接安装 wheel 文件（而非源目录）：
uv tool install dist/mcp_server_practices-0.3.0-py3-none-any.whl
⚠️ 重要提示
请勿直接使用
uv tool install .命令在源目录上操作，这可能导致文件损坏。务必先构建 wheel 文件。
💻 使用示例
作为 MCP 服务器
该服务器可通过以下方式调用：
基础用法
# 使用 --from 参数运行服务器
uvx --from mcp-server-practices practices [选项]
# 显示版本号
uvx --from mcp-server-practices practices --version
⚠️ 重要提示
直接通过
uvx mcp-server-practices调用的功能支持计划在未来版本中实现。
服务器选项
--log-level：设置日志级别（DEBUG、INFO、WARNING、ERROR、CRITICAL）--project-root：指定项目根目录--log-file：启用文件日志记录（默认）--no-log-file：禁用文件日志记录--log-file-path：指定自定义日志文件路径
作为 CLI 工具
# 访问 CLI 功能
uvx --from mcp-server-practices practices cli [命令] [选项]
⚠️ 重要提示
直接通过
uvx mcp-server-practices cli调用的功能支持计划在未来版本中实现。
分支命令
# 验证分支名称
uvx --from mcp-server-practices practices cli branch validate feature/ABC-123-description
# 创建分支
uvx --from mcp-server-practices practices cli branch create feature/ABC-123-description
Jira 命令
# 获取问题详细信息
uvx --from mcp-server-practices practices cli jira issue ABC-123
# 更新问题状态
uvx --from mcp-server-practices practices cli jira update ABC-123 "In Progress"
📚 详细文档
MCP 配置
"practices": {
"command": "practices",
"args": [
"--log-level",
"ERROR"
],
"disabled": false,
"autoApprove": [
"validate_branch_name",
"get_branch_info",
"validate_version"
]
}
开发相关
测试
python -m pytest
许可证头文件
uvx --from mcp-server-practices practices cli headers add /path/to/your/source/directory
📄 许可证
本项目采用 MIT 许可证。