项目简介

'mcp-azdo' 是一个命令行工具,它作为一个Model Context Protocol (MCP) 服务器运行,提供一套与Azure DevOps、JIRA和Splunk服务交互的实用工具。它允许您管理测试用例、测试套件、其他工作项,创建JIRA子任务,并执行Splunk查询,从而为大型语言模型(LLM)客户端提供丰富的上下文信息和自动化能力。

主要功能点

  • Azure DevOps 集成: 获取工作项详情,创建/更新测试用例(支持步骤、优先级、分配人、自动化状态),创建/获取测试套件,添加/复制测试用例到测试套件,获取测试套件下的所有测试用例和子测试套件。
  • JIRA 集成: 获取JIRA问题详情,关联Azure DevOps测试用例到JIRA问题并更新描述,创建基于模板或自定义内容的JIRA子任务。
  • Splunk 集成: 执行SPL (Search Processing Language) 查询,搜索日志、指标和机器数据,支持时间范围和结果限制。

安装步骤

在使用前,请确保您的系统已安装 Node.js 和 npm。

  1. 全局安装 (推荐): 打开命令行工具,运行以下命令:
    npm install -g mcp-azdo
  2. 本地开发设置 (开发者使用):
    git clone https://github.com/michaelnguyenwex/azure-devops-mcp
    cd azure-devops-mcp
    npm install
    npm run build
    npm link # 这将使 'azdo-mcp' 命令在您的本地环境中可用

服务器配置

MCP客户端需要MCP服务器的启动命令才能与之通信。本MCP服务器通过标准输入/输出 (Stdio) 协议运行。

一个典型的MCP客户端配置应包含以下信息(请根据您的实际环境替换占位符):

{
  "server": {
    "name": "WexAZDO",
    "command": "azdo-mcp", // 用于启动MCP服务器的命令。如果您通过 'npm link' 安装,可以直接使用 'azdo-mcp'。如果使用 'npx' 运行,则为 'npx mcp-azdo'。
    "args": [],           // 启动MCP服务器时无需额外参数。
    "capabilities": {
      "tools": [          // 此MCP服务器提供的工具列表。
        "fetch-item",
        "create-testcase",
        "update-automated-test",
        "add-testcase-to-testsuite",
        "copy-testcases-to-testsuite",
        "create-jira-subtasks",
        "add-testcase-jira",
        "get-all-testcases-from-testsuite",
        "get-child-test-suites",
        "search_splunk"
      ]
    }
  }
}

环境变量配置: 在运行服务器前,您需要设置以下环境变量来连接Azure DevOps、JIRA和Splunk。您可以在Shell环境中设置这些变量,或在项目根目录创建名为 '.env' 的文件,并按以下格式添加内容:

# Azure DevOps (必需)
AZDO_ORG=您的Azure DevOps组织名称
AZDO_PROJECT=您的Azure DevOps项目名称
AZDO_PAT=您的Azure DevOps个人访问令牌 (PAT)。该PAT需具备足够权限,例如:“工作项读写”和“测试管理读写”。

# JIRA (必需)
JIRA_PAT=您的JIRA API密钥。这是一个Base64编码的“邮箱:API令牌”字符串。
JIRA_API_BASE_URL=您的JIRA实例基础URL (例如:https://your-domain.atlassian.net)

# Splunk (可选)
# 如果您想使用Splunk功能,请配置以下变量。
# 可以选择提供完整的SPLUNK_URL,或分开设置主机、端口和协议。
SPLUNK_URL=https://your-splunk.com:8089 # Splunk完整URL
# 或者:
# SPLUNK_HOST=your-splunk.com             # Splunk主机名
# SPLUNK_PORT=8089                      # Splunk API端口 (默认: 8089)
# SPLUNK_SCHEME=https                   # 协议 (http 或 https)
SPLUNK_TOKEN=您的Splunk认证令牌
VERIFY_SSL=false                       # 是否验证SSL证书 (true 或 false)。建议在开发环境设置为 false,生产环境设置为 true。

基本使用方法

安装并配置好环境变量后,您可以通过以下命令启动MCP服务器:

azdo-mcp

或者 (如果您选择使用 'npx' 运行):

npx mcp-azdo

服务器启动后,它将通过标准输入/输出接口监听MCP客户端的请求。此时,LLM客户端即可调用其注册的工具来执行各种Azure DevOps、JIRA和Splunk操作。

信息

分类

开发者工具