项目简介

Practices MCP Server 是一个专门为AI助手(如Claude)设计的MCP(模型上下文协议)服务器。它旨在帮助开发者在各种项目中实施一致的开发实践,提升代码质量和团队协作效率。

主要功能点

  • Git分支管理: 根据项目配置,创建和验证符合规范的分支名称。
  • 版本控制: 检查和更新多个文件中的版本号,保持版本信息的一致性。
  • Pull Request 准备: 生成标准化的PR描述,并进行PR就绪性检查。
  • 工具集成: 与GitHub和Jira等工具集成,实现工作流程自动化。
  • 自然语言交互: 允许通过自然语言与AI助手交互,简化操作流程。
  • 可配置性: 通过 '.practices.yaml' 配置文件灵活定制服务器行为,适应不同项目的需求。
  • 系统指令资源: 提供项目特定的系统指令,指导AI助手正确使用工具。
  • 日志记录: 支持文件日志记录,方便问题追踪和审计。

安装步骤

  1. 安装 mcp_server_practices 工具:

    推荐使用 'uv' 进行安装:

    uv tool install mcp_server_practices

    或者使用 'pip':

    pip install mcp-server-practices
  2. 配置 Claude (或其他 MCP 客户端):

    在 Claude 的配置中添加 Practices MCP Server。以下是一个示例 'json' 配置,你需要将其添加到你的 Claude 客户端配置中:

    {
      "mcpServers": {
        "practices": {
          "command": "practices-server",
          "args": [],
          "disabled": false,
          "autoApprove": [
            "validate_branch_name",
            "get_branch_info",
            "validate_version",
            "get_current_version",
            "bump_version",
            "generate_pr_description",
            "prepare_pr",
            "submit_pr",
            "create_pull_request",
            "install_pre_commit_hooks",
            "check_git_repo_init",
            "update_pre_commit_hooks",
            "add_license_header",
            "verify_license_header",
            "process_license_headers_batch",
            "get_github_repository_info",
            "create_github_branch",
            "create_github_pull_request",
            "get_github_file_contents",
            "update_github_file",
            "get_github_workflow_status",
            "set_working_directory"
          ]
        }
      }
    }

    配置参数说明:

    • 'server name': 'practices' - 服务器的名称,在客户端配置中用于标识和调用。
    • 'command': 'practices-server' - 启动 Practices MCP Server 的命令。
    • 'args': '[]' - 启动命令的参数,这里为空,表示不传递额外参数。
    • 'disabled': 'false' - 设置为 'false' 表示启用该服务器。
    • 'autoApprove': 工具列表 - 列出的工具将在调用时自动批准,无需用户手动确认,根据需要调整列表。

基本使用方法

配置完成后,你可以通过自然语言指示 Claude (或其他 MCP 客户端) 使用 Practices MCP Server 的功能。例如:

  • "创建一个 feature 分支,用于 PMS-123 用户认证功能"
  • "检查项目中的版本号是否一致"
  • "为当前分支准备一个 Pull Request"
  • "安装 pre-commit hooks"
  • "检查代码库是否最近初始化"
  • "更新 pre-commit hooks"
  • "为 README.md 文件添加 license header"
  • "检查当前目录下所有 Python 文件是否包含 license header"

更多详细用法,请参考仓库中的 用户指南配置指南

信息

分类

开发者工具