OpenProject集成服务器

一个用于将OpenProject与AI助手(如Windsurf)及其他MCP兼容客户端集成的MCP服务器。

  • by boma086
  • Python
  • 本地部署
  • 更新于
在 GitHub 查看 boma086/mcp-openproject

使用说明

MCP OpenProject 服务器

一个用于将OpenProject与Windsurf等AI助手以及其他兼容MCP的客户端集成的模型上下文协议(MCP)服务器。 版本0.0.2 | 状态生产就绪 | PyPI: mcp-openproject 翻译为中文是:“MCP-开放项目”或“MCP-开源项目”(具体取决于上下文,如果指的是一个使用MCP(可能指某种开发框架或平台)的开源项目,则后者更贴切)

🚀 快速入门

选项1:从PyPI或GitHub安装(推荐给用户)

#pipx (isolated environment)
pipx install mcp-openproject
#or Install from PyPI
pip install mcp-openproject
# Install globally from GitHub
pipx install git+https://github.com/boma086/mcp-openproject.git
# Test installation
mcp-openproject --help

选项2:开发安装

# Clone repository
git clone https://github.com/boma086/mcp-openproject.git
cd mcp-openproject
# Install in development mode
pip install -e .

⚙️ MCP 客户端配置

风帆冲浪配置

在您的MCP客户端配置中添加以下内容:

{
  "mcpServers": {
    "openproject": {
      "command": "mcp-openproject",
      "args": ["server", "--stdio"],
      "env": {
        "OPENPROJECT_BASE_URL": "http://localhost:8090/",
        "OPENPROJECT_API_KEY": "your-api-key-here"
      }
    }
  }
}

特点/功能

  • 🚀 PyPI 安装使用以下命令从 PyPI 安装: pip install mcp-openproject
  • 📡 多种传输模式Stdio(计划支持HTTP Server-Sent Events)
  • 🔗 OpenProject API 集成完全访问项目、工作包和任务
  • 🛡️ 安全加密配置和API密钥管理
  • **🖥️ 命令行界面 (CLI Interface)**全面的命令行工具
  • **🎯 兼容MCP(微软认证专家)**与帆板运动及其他MCP客户端兼容
  • ✅ 生产测试通过已验证安装和CLI(命令行界面)功能

CLI 命令

# Show help
mcp-openproject --help
# Test connection to OpenProject
mcp-openproject test
# Show current configuration
mcp-openproject config
# Start MCP server in different modes
mcp-openproject server --stdio          # Stdio mode (for MCP clients)
mcp-openproject server --http --port 8000  # HTTP mode
# Check server status
mcp-openproject status

可用的MCP工具

  • 项目管理列出项目,获取项目详情,查看项目统计数据
  • 工作包创建、阅读、更新工作包和任务
  • 周报为项目生成每周报告
  • 时间追踪记录日志条目,跟踪项目工时
  • 团队管理访问用户信息和团队分配情况

建筑

这个项目采用了一种综合架构,其中包括:

  • MCP 服务器基于FastMCP的实现,支持多种传输模式
  • OpenProject 集成生成了支持OpenProject的完整API客户端
  • 安全框架加密配置和API密钥管理
  • **命令行界面(CLI)**全面的命令行工具,支持所有操作

关键组件

  • mcp_server/核心MCP服务器实现
  • pyproject.toml项目配置,具备全面的依赖管理 #- smithery.yamlSmithery平台部署配置

运输方式

✅ 标准输入输出模式(推荐用于MCP客户端)

  • 用例与Claude Code、Windsurf及其他MCP客户端的直接集成
  • 命令: mcp-openproject server --stdio
  • 好处标准MCP协议,低延迟,安全

🚧 HTTP 模式(计划中)

  • 用例网络应用程序,HTTP API 集成
  • 命令: mcp-openproject server --http --port 8000
  • 好处RESTful API,网页友好,支持CORS

🚧 SSE模式(计划中)

  • 状态计划在未来发布
  • 用例实时更新,流式响应
  • 命令: mcp-openproject server --sse --port 8001 (未来的)

许可证

MIT 许可证 - 详见 许可证 文件中有详细信息

更新日志

看 CHANGELOG.md 翻译为中文是:“变更日志文件(Markdown 格式)” 用于查看版本历史和更新。