使用说明
GeXDigital的OpenProject MCP服务器
一种高性能的模型上下文协议(MCP)服务器 打开项目 API v3与人工智能应用程序的集成。
版本1.2.0 • 50工具
目录
快速入门(5分钟)
先决条件
- Python 3.10或更高版本
- 紫外线 包管理器
- 具有API访问权限的OpenProject实例
安装
1.安装uv(如果需要):
curl -LsSf https://astral.sh/uv/install.sh | sh
2.克隆和设置:
git clone <your-repo-url>
cd gx-op-mcp
uv sync
3.配置环境:
cp env_example.txt .env
编辑 .env 使用您的OpenProject凭据:
OPENPROJECT_URL=https://your-instance.openproject.com
OPENPROJECT_API_KEY=your-api-key-here
4.测试连接:
uv run python openproject-mcp.py
✅ 完成! 您的MCP服务器正在运行。
特性
核心能力
- 50个生产就绪工具 -完成OpenProject API v3覆盖范围
- 高性能 -Sub-110ms工具发现,负执行开销
- 模块化架构 -自注册工具,代码减少96.9%
- 完整的CRUD操作 -项目、工作包、用户、角色、成员资格
关键操作
- 📋 项目管理 -具有父/子关系的分层项目
- 📝 工作包 -具有时间跟踪和预算的完整生命周期
- 🔗 关系 -复杂的依赖关系(块、跟随、前置、必需)
- 💬 评论 -创建、读取、更新活动历史记录
- ⏱️ 时间追踪 -记录活动类型的小时数
- 👥 团队管理 -用户、角色和项目成员资格
- 📊 视图和导出 -Excel导出查询系统
技术特性
- 🔐 安全的API密钥身份验证
- 🌐 企业环境的代理支持
- 🔒 可配置的SSL验证
- 🚀 异步/等待并发操作
- 📊 全面的错误处理和记录
文档
入门指南
参考文档
迁移和升级
- 迁移指南 -从v1.0.x升级到v1.1.0
外部资源
- OpenProject API文档 -API官方参考
- 模型上下文协议 -MCP规范
配置
环境变量
| 变量 | 必填 | 描述 |
|---|---|---|
OPENPROJECT_URL |
是 | 您的OpenProject实例URL |
OPENPROJECT_API_KEY |
是 | 用户配置文件中的API密钥 |
OPENPROJECT_PROXY |
否 | HTTP代理URL(如果需要) |
OPENPROJECT_VERIFY_SSL |
否 | 验证SSL证书(默认值: true) |
获取API密钥
- 登录您的OpenProject实例
- 点击您的头像→ 我的账户
- 引导到 访问令牌
- 点击 +添加 创建新令牌
- 将生成的令牌复制到您的
.env文件
整合
克劳德桌面
添加到您的Claude Desktop配置文件中:
macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
窗户: %APPDATA%\Claude\claude_desktop_config.json
{
"mcpServers": {
"openproject": {
"command": "/path/to/gx-op-mcp/.venv/bin/python",
"args": ["/path/to/gx-op-mcp/openproject-mcp.py"]
}
}
}
替换 /path/to/gx-op-mcp/ 使用您的实际安装路径。
其他MCP客户端
服务器实现了标准的MCP协议,并与任何兼容的客户端一起工作。请参阅 MCP文件 了解集成细节。
发展
设置开发环境
uv sync --extra dev
运行测试
uv run pytest tests/
代码格式化
uv run black openproject-mcp.py
uv run flake8 openproject-mcp.py
添加依赖关系
uv add package-name # Add runtime dependency
uv add --dev package-name # Add dev dependency
贡献
欢迎投稿!请按照以下步骤操作:
- 克隆该仓库
- 创建要素分支(
git checkout -b feature/amazing-feature) - 提交您的更改(
git commit -m 'Add amazing feature') - 推到分支(
git push origin feature/amazing-feature) - 打开拉取请求
许可证
此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。
支持
- 🐛 问题: 通过GitHub Issues报告错误或请求功能
- 📖 文档: 检查 文档 详细指南目录
- 💡 问题: 打开GitHub讨论
维护者
这是一个经过维护的叉子 openproject mcp服务器.
特别感谢 @一切 为这个项目奠基。 我们创建这个分叉是为了在保持原始愿景的同时更快地做出贡献和发展。
维护人员: GeXDigital Networks
快速参考
最常用的工具
# Connection & Setup
test_connection # Verify API connection
check_permissions # Check user capabilities
# Projects
list_projects # List all accessible projects
get_project # Get project details
create_project # Create new project
# Work Packages
list_work_packages # List work packages with filters
get_work_package # Get work package details
create_work_package # Create new work package
update_work_package # Update work package
# Time Tracking
create_time_entry # Log time on work package
list_time_entries # List time entries
# Views & Export
get_view # Retrieve saved query
export_view # Export view to Excel
看 工具参考 查看50种工具的完整列表。
版权所有(c)2026 GeXDigital Networks和贡献者 根据MIT许可证获得许可。
由以下材料制成❤️ 由社区和GeXDigital Networks提供。