alm MCP

Perforce ALM MCP服务器

注： Helix ALM已更名为 表演ALM。此服务器以Perforce ALM（以前为Helix ALM）REST API为目标。环境变量、工具名称和配置键仍然使用 HELIX_ALM_ 前缀用于向后兼容性。

A. 模型上下文协议（MCP） 将Claude（和其他兼容MCP的AI助手）连接到 表演ALM （前身为Helix ALM）REST API。它允许您直接从对话中管理需求、测试用例、文档和自动化结果，并具有可选的Azure DevOps集成，用于将CI/CD测试结果拉入Perforce ALM。

______________________________________________________________________

特性

• 需求 --列出、搜索、创建、更新、删除和触发工作流事件
• 测试用例 --列出、搜索、创建、读取、更新和附加步骤；链接到需求
• 需求文件 --浏览文档树，向部分添加要求，创建快照
• 自动化套房 --提交测试运行结果（手动、从JUnit/xUnit XML或从Azure DevOps构建中）；按名称或ID列出的参考套件
• Azure DevOps --从构建中提取测试结果，并将其直接推送到Perforce ALM自动化套件中
• 默认项目 --设置一次 set_default_project 并省略 project_name 每次后续通话
• 现场发现 --在创建项目之前查找有效的优先级、状态、类别或类型值
• 基于会话的身份验证 --凭据仅保存在内存中，从不写入磁盘

______________________________________________________________________

需求

• Python 3.11+
• mcp 包装(pip install mcp)
• 启用REST API的正在运行的Perforce ALM服务器（以前推荐使用Helix ALM，24版或更高版本）
• API令牌（推荐）或用户名/密码

______________________________________________________________________

安装

git clone https://github.com/gerhardkrugerdev/alm_mcp.git
cd alm_mcp
pip install mcp

复制示例环境文件并填写您的详细信息（可选——您还可以通过 configure_helix_alm 运行时工具）：

cp .env.example .env

______________________________________________________________________

运行服务器

python helix_alm_mcp.py

服务器通过以下方式进行通信 标准，这是MCP客户端（如Claude Desktop和Claude Code）的标准传输。

Claude桌面配置

将此块添加到您的 claude_desktop_config.json:

{
  "mcpServers": {
    "helix-alm": {
      "command": "python",
      "args": ["C:/path/to/alm_mcp/helix_alm_mcp.py"],
      "env": {
        "HELIX_ALM_URL": "https://your-server:8443/",
        "HELIX_ALM_API_KEY": "your-api-key",
        "HELIX_ALM_API_SECRET": "your-api-secret"
      }
    }
  }
}

Claude代码配置

将相同的块添加到您的Claude代码中 settings.json 在...之下 "mcpServers".

______________________________________________________________________

认证

服务器支持两种身份验证方法：

通过环境变量设置的凭据在启动时加载。您可以随时通过调用来覆盖它们 configure_helix_alm 在谈话中。

______________________________________________________________________

工具参考

配置

configure_helix_alm

为当前会话配置Perforce ALM（以前称为Helix ALM）连接。URL会自动规范化——您可以传递基本URL或其下的任何路径（例如。 https://server:8443/helix-alm/api/v0)，它将正确解决。如果服务器只有一个项目，则会自动选择它作为默认项目。

configure_azure_devops

为当前会话配置Azure DevOps连接。

get_connection_status

返回Perforce ALM和Azure DevOps的当前连接状态（不透露凭据）。包括当前默认项目。

set_default_project

设置会话的默认项目。一旦设置，所有接受的工具 project_name 当省略参数时，将使用此项目。

get_field_values

发现需求或测试用例中特定字段当前使用的值。在创建或更新项目之前，可用于查找有效的优先级、状态、类别或其他菜单字段值。

注： 这会从现有项目中发现值，因此尚未使用的值可能不会出现。如果找不到字段名，该工具将返回可用字段标签的列表。

______________________________________________________________________

需求

示例——创建需求：

Create a functional requirement in "My Project" with summary "User login via SSO"
and description "The system must support SAML 2.0 SSO for all users."

______________________________________________________________________

测试用例

create_test_case 参数

步骤格式：

[
  {"text": "Open the login page", "expectedResult": "Login page is displayed"},
  {"text": "Enter valid credentials", "expectedResult": "User is redirected to the dashboard"}
]

注： Perforce ALM REST API不支持在测试用例创建（POST）期间内联添加步骤。此服务器通过首先创建测试用例，然后通过PUT向 /testCases/{id}/steps 使用子资源 detailed 步骤格式。

get_test_case 参数

返回测试用例字段、所有步骤（具有预期结果）和链接项。步骤从 /steps 子资源，因为主测试用例端点不包括它们。

update_test_case 参数

所有参数都是可选的，只有您提供的字段才会被更新。步骤被完全替换（未合并）。要添加步骤而不删除现有步骤，请使用 add_test_case_steps 相反。

add_test_case_steps 参数

该工具获取现有的步骤，附加新的步骤，并将组合列表PUT返回到API。

link_test_case_to_requirement 参数

例子：

Create a test case in "My Project" titled "Verify SSO login flow" with type Validation
and steps: navigate to login, click SSO, verify redirect. Then link it to requirement BR-1960.

______________________________________________________________________

需求文件

______________________________________________________________________

自动化套房

所有自动化套件工具都接受一个套件 名字 （例如。 "Regression Suite")或 数字ID.

______________________________________________________________________

JUnit / xUnit XML 文件

这些工具允许您直接从CI生成的XML文件中提交测试结果。

示例XML文件在 samples/ 目录。

______________________________________________________________________

Azure DevOps集成

端到端示例：

Fetch the latest completed build from Azure DevOps pipeline 42 and submit
the test results to Perforce ALM automation suite 7 in project "My Project".

______________________________________________________________________

环境变量

所有变量都是可选的——服务器将回退到 configure_* 如果没有设置工具。

______________________________________________________________________

安全注意事项

• 凭据是 从未写入磁盘 --它们仅在会话的生命周期内存在于进程内存中。
• 这 .env 通过以下方式将文件排除在版本控制之外 .gitignore.使用 .env.example 作为模板。
• 默认情况下，SSL验证被禁用，以支持内部Perforce ALM部署中常见的自签名证书。启用它(ssl_verify=true)当连接到具有可信证书的服务器时。