项目简介

Dev-Kit MCP 服务器是一个专为AI辅助开发工具(如VS Code Copilot)设计的后端服务。它通过实现Model Context Protocol (MCP) 标准,使大型语言模型(LLM)能够安全地访问和操作项目文件系统、执行Git命令、运行Makefile任务以及自定义脚本,从而将任何代码库转化为MCP兼容系统,助力AI代理进行更智能的开发。

主要功能点

  • 安全操作: 在指定根目录下执行文件和命令,所有操作均受严格权限范围控制。
  • 文件系统操作: 支持创建、编辑、移动、重命名和删除文件及目录。
  • Git 版本控制: 可执行Git状态查询、添加文件、提交、推送、拉取和分支切换等操作。
  • Makefile 任务执行: 允许安全地运行项目中的Makefile目标。
  • 代码探索: 提供文件搜索、文本内容搜索和指定行范围读取等功能,方便LLM理解代码库。
  • 预定义命令: 支持通过TOML文件(如'pyproject.toml')配置并执行常用脚本命令。
  • 易于集成: 专门针对VS Code Copilot等AI开发工具优化,提供即插即用的集成方案。

安装步骤

通过Python的包管理器 'pip' 即可轻松安装:

pip install dev-kit-mcp-server

服务器配置(MCP客户端使用)

MCP客户端(如VS Code扩展)需要知道如何启动这个服务器才能与其通信。以下是JSON格式的配置示例及其注释,描述了如何配置MCP客户端以启动和连接到Dev-Kit MCP服务器。您通常会将此配置添加到 '.vscode/mcp.json' 或类似的客户端配置文件中。

{
  "servers": {
    "dev-kit-mcp-server": {
      "command": "uvx",                     // 启动MCP服务器的可执行文件或命令。这里使用 'uvx',用于确保服务器在正确的虚拟环境中运行。
      "args": [                             // 传递给 'command' 的命令行参数列表。
        "-n", "dev-kit-mcp-server",         // 'uvx' 的参数,指定要运行的包名。
        "--root-dir", "${workspaceFolder}"  // MCP服务器的关键参数,指定服务器可以操作的根目录。'${workspaceFolder}' 是一个占位符,客户端会在运行时替换为当前项目的工作区路径,确保服务器操作的安全性。
      ],
      "env": {}                             // 环境变量,如果服务器需要特定的环境变量,可以在这里配置。
    }
  }
}

基本使用方法

安装完成后,您可以通过命令行启动Dev-Kit MCP服务器。建议在指定项目根目录的情况下运行,以确保操作的安全性。

  1. 启动服务器(推荐指定根目录): 在您的项目根目录下打开终端,运行:

    dev-kit-mcp-server --root-dir=.

    这会将当前目录设置为服务器操作的根目录。

  2. 使用自定义TOML文件定义预设命令: 如果您希望使用一个名为 'custom_commands.toml' 的文件来定义预设命令,可以这样启动:

    dev-kit-mcp-server --root-dir=. --commands-toml=custom_commands.toml

    在该 'custom_commands.toml' 文件中,您可以像这样定义命令:

    # custom_commands.toml
    [tool.dkmcp.commands]
    test = "pytest"
    lint = "ruff check ."
    build = "python setup.py build"

    然后,MCP客户端就可以通过调用 'predefined_commands' 工具并指定 'command' 参数来执行这些预设命令(例如,执行 'test' 命令会运行 'pytest')。

服务器启动后,将监听MCP客户端的JSON-RPC请求,执行相应的工具操作并返回结果。

信息

分类

开发者工具