Practices MCP Server

🚀 MCP 服務器實踐規範

MCP 服務器是一個基於 Model Context Protocol（MCP）的工具，它能強制執行和自動化一系列開發實踐，幫助開發者更高效地進行項目開發。

🚀 快速開始

MCP 服務器提供了一系列工具，可幫助實施和自動化以下開發實踐：

• 分支名稱驗證
• 版本管理
• 提交拉取請求準備
• 許可證頭文件管理
• 預提交鉤安裝

📦 安裝指南

常規安裝

pip install mcp-server-practices

開發環境安裝

pip install -e .

使用 UV 工具安裝

如果你想使用 UV 工具全局安裝該包，請按照以下步驟操作以避免文件損壞：

選項 1：使用 install_full 腳本

# 清理、構建和一次性安裝
./install_full.sh

此腳本將執行以下操作：

1. 清理之前的構建 artifacts
2. 構建包
3. 使用 UV 工具安裝最新生成的 wheel 文件

選項 2：手動過程

1. 首先，構建包的 wheel 文件：

   python -m build
   

2. 直接安裝 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 調用的功能支持計劃在未來的版本中實現。

服務器選項

作為 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