使用说明

项目简介

Dev Kit 是一个强大的 Model Context Protocol (MCP) 服务器,它充当 AI 模型(如 Claude)和各种开发工具及服务之间的桥梁。通过实现 MCP 协议,Dev Kit 允许 AI 模型以结构化和安全的方式与 Jira、Confluence、GitLab、GitHub 等工具进行交互,从而实现开发工作流程的自动化,文档管理和版本控制等任务。

主要功能点

  • 资源管理: 虽然文档中没有明确提及资源管理,但 MCP 服务器定义包含资源管理,'main.go' 中 'server.WithResourceCapabilities(true, true)' 表明 Dev Kit 具备资源管理能力。
  • 工具注册与执行: 集成了 Confluence, Jira, GitLab, GitHub 和脚本执行等多种工具,覆盖文档协作、项目管理、代码托管和系统命令执行等多个开发环节,允许 LLM 调用这些工具来完成特定任务。
  • Prompt 模板: 虽然文档没有明确提及 Prompt 模板功能,但 'main.go' 中 'server.WithPromptCapabilities(true)' 表明 Dev Kit 具备 Prompt 模板能力,可能在内部使用以定制 LLM 交互。
  • 协议支持: 支持 STDIO 和 SSE 两种传输协议,方便与不同类型的 MCP 客户端集成。
  • 灵活的工具启用: 通过环境变量 'ENABLE_TOOLS' 可以灵活控制启用的工具组,方便用户按需配置。

安装步骤

  1. 安装 Go: 确保已安装 Go 语言环境,版本要求 1.23.2 或更高。
  2. 安装 Dev Kit 服务器: 打开终端,执行以下命令安装 Dev Kit:
    go install github.com/nguyenvanduocit/dev-kit@latest
  3. 配置环境变量:
    • 在本地创建 '.env' 文件,并根据需要配置以下环境变量。请根据你要使用的工具配置相应的 API 密钥和令牌。

      # Atlassian 服务 (Jira & Confluence) 必需配置
      ATLASSIAN_HOST=        # 你的 Atlassian 实例 URL (例如, https://your-domain.atlassian.net)
      ATLASSIAN_EMAIL=       # 你的 Atlassian 账户邮箱
      ATLASSIAN_TOKEN=       # 你的 Atlassian API 令牌
      
      # GitLab 服务 必需配置
      GITLAB_HOST=           # 你的 GitLab 实例 URL
      GITLAB_TOKEN=          # 你的 GitLab 个人访问令牌
      
      # GitHub 服务 必需配置
      GITHUB_TOKEN=          # 你的 GitHub 个人访问令牌
      
      # 可选配置
      ENABLE_TOOLS=          # 逗号分隔的工具组列表,用于启用特定工具 (留空则启用所有工具)
      PROXY_URL=            # 可选: HTTP/HTTPS 代理 URL
      PORT=                 # SSE 服务器端口 (默认: 8080)
    • 请将占位符替换为你实际的值。例如,你需要访问 Jira 和 Confluence,则需要配置 'ATLASSIAN_HOST'、'ATLASSIAN_EMAIL' 和 'ATLASSIAN_TOKEN'。

服务器配置

MCP 客户端(例如 Claude)需要配置 MCP 服务器的启动命令和参数才能连接 Dev Kit 服务器。以下是 'claude_desktop_config.json' 的配置示例,请根据你的实际情况进行配置:

{
  "mcpServers": {
    "dev_kit": {
      "command": "dev-kit",
      "args": [
        "-env", "/path/to/.env",  //  '.env' 文件的路径,请替换为你的实际路径
        "-protocol", "stdio"   //  指定通信协议,可选 "stdio" 或 "sse",默认为 "stdio"
      ]
    }
  }
}
  • server name: 'dev_kit' (服务器名称,可以自定义)
  • command: 'dev-kit' (Dev Kit 服务器的启动命令,假定 'dev-kit' 命令已添加到系统 PATH 环境变量中,否则需要使用完整路径)
  • args: 启动参数,包括:
    • '-env': 指定 '.env' 文件的路径,用于加载环境变量。请将 '/path/to/.env' 替换为你实际的 '.env' 文件路径。
    • '-protocol': 指定 MCP 服务器使用的通信协议。
      • 'stdio': 使用标准输入/输出流进行通信(默认)。
      • 'sse': 使用 Server-Sent Events 协议进行 HTTP 长连接通信。如果使用 SSE 协议,Dev Kit 服务器将监听在 'PORT' 环境变量指定的端口(默认为 8080)。

注意:

  • 请根据你的 MCP 客户端的具体配置方法进行配置。
  • 如果使用 SSE 协议,请确保 MCP 客户端支持 SSE 协议,并配置正确的服务器地址 'http://localhost:PORT' (PORT 为你设置的端口号)。

基本使用方法

  1. 启动 Dev Kit 服务器。如果使用 STDIO 协议,在终端中直接运行 'dev-kit -env /path/to/.env -protocol stdio'(请替换为你的实际路径和参数)。如果使用 SSE 协议,运行 'dev-kit -env /path/to/.env -protocol sse -port 8080'(请替换为你的实际路径和端口)。
  2. 在 MCP 客户端(如 Claude)中配置并连接到 Dev Kit 服务器。
  3. 通过自然语言指令,指示 MCP 客户端调用 Dev Kit 提供的工具,例如:
    • "使用 Jira 工具搜索 'bug 修复'相关的 issue"
    • "使用 Confluence 工具获取页面 ID 为 '12345' 的页面内容"
    • "使用 GitHub 工具列出用户 'your-username' 的所有仓库"

Dev Kit 服务器将处理来自 MCP 客户端的请求,调用相应的开发工具 API,并将结果返回给客户端,从而实现 AI 模型与开发工具的集成和自动化工作流程。

信息

分类

开发者工具