使用说明
OpenProject MCP服务器
一个模型上下文协议(MCP)服务器,使AI代理能够与OpenProject的APIv3进行交互,以实现自主项目管理。
概述
此MCP服务器提供了一套全面的工具,允许AI代理:
- 列出、创建、更新和删除项目
- 管理工作包(任务、错误、功能等)
- 处理项目成员和版本
- 查询状态、类型、优先级、用户和角色
- 跨工作包搜索
特性
项目
- 列出所有具有分页和筛选功能的项目
- 获取详细的项目信息
- 创建新项目
- 更新项目详细信息(名称、描述、状态)
- 删除项目
- 管理项目成员(添加/删除)
- 管理项目版本
工作包
- 列出具有高级筛选功能的工作包
- 获取详细的工作包信息
- 创建新的工作包
- 更新工作包(状态、优先级、受让人、日期等)
- 删除工作包
- 查看活动历史记录和评论
- 向工作包添加注释
- 管理工作包之间的关系
参考数据
- 列出所有可用状态
- 列出所有工作包类型
- 列出所有优先级
- 列出所有用户
- 列出项目中可分配的用户
- 列出所有角色
- 列出所有组
搜索
- 跨工作包的全文搜索
先决条件
- Node.js 18+
- 具有API访问权限的OpenProject实例
安装
# Clone or download this repository
cd openproject-mcp
# Install dependencies
npm install
# Build the TypeScript code
npm run build
配置
设置以下环境变量:
export OPENPROJECT_BASE_URL="https://your-openproject-instance.com"
export OPENPROJECT_API_KEY="your-api-key"
获取API密钥:
- 登录OpenProject
- 转到我的帐户→ API访问密钥
- 生成新的API密钥
跑步
# Set environment variables first
export OPENPROJECT_BASE_URL="https://your-openproject-instance.com"
export OPENPROJECT_API_KEY="your-api-key"
# Run the server
node dist/index.js
Claude桌面集成
添加到您的 claude.json:
{
"mcpServers": {
"openproject": {
"command": "node",
"args": ["/path/to/openproject-mcp/dist/index.js"],
"env": {
"OPENPROJECT_BASE_URL": "https://your-openproject-instance.com",
"OPENPROJECT_API_KEY": "your-api-key"
}
}
}
}
用法示例
以下是代理如何使用这些工具:
- 列出项目 看看有什么可用的
- 获取项目类型 了解存在哪些工作包类型
- 获取状态 了解哪些转变是可能的
- 列出用户 寻找可分配的团队成员
- 创建工作包 有主题、类型、优先级
- 更新工作包 随着工作的进展(更改状态,更新受让人)
- 添加评论 记录进度
- 搜索 查找相关工作包
工具参考
| 工具 | 说明 |
|---|---|
op_list_projects |
列出所有项目 |
op_get_project |
获取项目详细信息 |
op_create_project |
创建新项目 |
op_update_project |
更新项目 |
op_delete_project |
删除项目 |
op_list_project_members |
列出项目成员 |
op_add_project_member |
将成员添加到项目 |
op_remove_project_member |
从项目中删除成员 |
op_list_project_versions |
列出项目版本 |
op_create_version |
创建版本 |
op_list_work_packages |
列出工作包 |
op_get_work_package |
获取工作包详细信息 |
op_create_work_package |
创建工作包 |
op_update_work_package |
更新工作包 |
op_delete_work_package |
删除工作包 |
op_list_work_package_activities |
列出活动 |
op_add_work_package_comment |
添加评论 |
op_list_work_package_relations |
列出关系 |
op_create_work_package_relation |
创建关系 |
op_delete_work_package_relation |
删除关系 |
op_get_project_work_packages |
获取项目中的所有WP |
op_list_statuses |
列出所有状态 |
op_list_types |
列出所有类型 |
op_get_project_types |
列出项目中的类型 |
op_list_priorities |
列出所有优先级 |
op_list_users |
列出所有用户 |
op_get_user |
获取用户详细信息 |
op_get_current_user |
获取当前用户 |
op_list_project_assignees |
列出可分配的用户 |
op_list_roles |
列出所有角色 |
op_list_groups |
列出所有组 |
op_search |
搜索工作包 |
建筑学
- client.ts:OpenProject API客户端使用axios进行基本验证
- index.ts:带有所有工具处理程序的MCP服务器实现
许可证
麻省理工学院