MCP服务器矩阵要求
一个MCP(模型上下文协议)服务器,将Claude连接到您的 矩阵要求 ALM实例。提供对项目、项目、文件夹、链接、标签、TODO和文档生成的完整CRUD访问。
先决条件
- Node.js 18+
- 具有API访问权限的矩阵需求实例
- API令牌(在用户菜单下的矩阵中创建一个→ 访问令牌)
设置
1.安装依赖项并构建
npm install
npm run build
2.配置环境变量
服务器需要两个环境变量:
| 变量 |
描述 |
示例 |
MATRIX_URL |
您的Matrix实例URL |
https://clouds5.matrixreq.com |
MATRIX_TOKEN |
您的API令牌(没有“令牌”前缀) |
abc123def456... |
3.添加到克劳德桌面
将此添加到您的 claude_desktop_config.json:
{
"mcpServers": {
"matrix-requirements": {
"command": "node",
"args": ["/absolute/path/to/matrix-req-mcp/dist/index.js"],
"env": {
"MATRIX_URL": "https://your-instance.matrixreq.com",
"MATRIX_TOKEN": "your-api-token-here"
}
}
}
}
4.添加到克劳德代码
claude mcp add matrix-requirements \
-e MATRIX_URL=https://your-instance.matrixreq.com \
-e MATRIX_TOKEN=your-api-token-here \
-- node /absolute/path/to/matrix-req-mcp/dist/index.js
可用工具
项目与导航
| 工具 |
说明 |
list_projects |
列出实例上的所有项目 |
get_project_info |
获取项目的类别和字段定义 |
get_folder_tree |
获取项目的根文件夹树 |
get_folder_children |
获取特定文件夹的子文件夹 |
项目(CRUD)
| 工具 |
说明 |
get_item |
获取包含所有字段、链接和标签的单个项目 |
search_items |
按MRQL或自由文本搜索项目(返回ID) |
search_items_with_details |
返回完整详细信息的搜索项目 |
create_item |
在文件夹中创建新项目 |
update_item_title |
更新项目的标题 |
set_field |
设置单个字段值 |
set_fields |
一次设置多个字段值 |
delete_item |
删除项目或文件夹 |
move_items |
将项目移动到其他文件夹 |
文件夹
| 工具 |
说明 |
create_folder |
在项目中创建新文件夹 |
链接(可追溯性)
| 工具 |
说明 |
get_links |
获取项目的所有上行链路和下行链路 |
add_downlink |
在项目之间添加跟踪链接 |
remove_downlink |
删除项目之间的跟踪链接 |
标签
| 工具 |
说明 |
set_labels |
在项目上设置标签 |
TODO和审计
| 工具 |
说明 |
get_todos |
获取项目的TODO |
get_audit |
获取更改/审核日志 |
文档生成
| 工具 |
说明 |
generate_document |
将DOC导出为PDF、HTML、DOCX或ODT |
MRQL搜索语法
Matrix使用MRQL进行结构化查询。示例:
mrql:category=REQ --所有要求
mrql:category=REQ AND title~"safety" --标题中带有“安全”的要求
mrql:category=TC AND label=approved --批准的测试用例
- 自由文本搜索也有效(只需传递一个搜索字符串)
发展
npm run dev # Watch mode - recompiles on changes
npm run build # One-time build
npm start # Run the server