Practices MCP Server

🚀 MCP Server Practices

An MCP (Model Context Protocol) server that provides tools to enforce and automate development practices.

🚀 Quick Start

This MCP server offers tools to implement and automate the following development practices:

• Branch name validation
• Version management
• Pull request preparation
• License header management
• Pre-commit hook installation

📦 Installation

pip install mcp-server-practices

For development installation:

pip install -e .

Using UV Tool

If you want to globally install the package using the UV tool, follow these steps to avoid file corruption:

Option 1: Use the install_full script

# Clean, build, and install in one go
./install_full.sh

This script will perform the following actions:

1. Clean previous build artifacts.
2. Build the package.
3. Install the newly generated wheel file using the UV tool.

Option 2: Manual process

1. First, build the wheel file of the package:

   python -m build
   

2. Install the wheel file directly (instead of the source directory):

   uv tool install dist/mcp_server_practices-0.3.0-py3-none-any.whl
   

⚠️ Important Note

Do not use the uv tool install . command directly on the source directory, as this may cause file corruption. Always build the wheel file first.

💻 Usage Examples

As an MCP Server

The server can be invoked as follows:

# Run the server with the --from parameter
uvx --from mcp-server-practices practices [options]

# Display the version number
uvx --from mcp-server-practices practices --version

⚠️ Important Note

Support for direct invocation via uvx mcp-server-practices is planned for future versions.

Server Options

• --log-level: Set the log level (DEBUG, INFO, WARNING, ERROR, CRITICAL).
• --project-root: Specify the project root directory.
• --log-file: Enable file logging (default).
• --no-log-file: Disable file logging.
• --log-file-path: Specify a custom log file path.

As a CLI Tool

# Access CLI functionality
uvx --from mcp-server-practices practices cli [command] [options]

⚠️ Important Note

Support for direct invocation via uvx mcp-server-practices cli is planned for future versions.

Branch Commands

# Validate a branch name
uvx --from mcp-server-practices practices cli branch validate feature/ABC-123-description

# Create a branch
uvx --from mcp-server-practices practices cli branch create feature/ABC-123-description

Jira Commands

# Get issue details
uvx --from mcp-server-practices practices cli jira issue ABC-123

# Update issue status
uvx --from mcp-server-practices practices cli jira update ABC-123 "In Progress"

📚 Documentation

MCP Configuration

"practices": {
  "command": "practices",
  "args": [
    "--log-level",
    "ERROR"
  ],
  "disabled": false,
  "autoApprove": [
    "validate_branch_name",
    "get_branch_info",
    "validate_version"
  ]
}

🔧 Technical Details

Development

Testing

python -m pytest

License Headers

uvx --from mcp-server-practices practices cli headers add /path/to/your/source/directory

📄 License

MIT