π¦
MCP OpenProject Server
Check the current status of the OpenProject integration. Monitor health to ensure reliable workflows. Use status checks to troubleshoot issues quickly.
0 installs
Trust: 43 β Fair
Devtools
Installation
npx mcp-openprojectAsk AI about MCP OpenProject Server
Powered by Claude Β· Grounded in docs
I know everything about MCP OpenProject Server. Ask me about installation, configuration, usage, or troubleshooting.
0/500
Loading tools...
Reviews
Documentation
MCP OpenProject Server
A Model Context Protocol (MCP) server for integrating OpenProject with AI assistants like Windsurf, and other MCP-compatible clients. Version: 0.0.2 | Status: Production Ready | PyPI: mcp-openproject
π Quick Start
Option 1: Install from PyPI or github (Recommended for Users)
#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
Option 2: Development Installation
# Clone repository
git clone https://github.com/boma086/mcp-openproject.git
cd mcp-openproject
# Install in development mode
pip install -e .
βοΈ MCP Client Configuration
Windsurf Configuration
Add this to your MCP client configuration:
{
"mcpServers": {
"openproject": {
"command": "mcp-openproject",
"args": ["server", "--stdio"],
"env": {
"OPENPROJECT_BASE_URL": "http://localhost:8090/",
"OPENPROJECT_API_KEY": "your-api-key-here"
}
}
}
}
Features
- π PyPI Installation: Install from PyPI with
pip install mcp-openproject - π‘ Multiple Transport Modes: Stdio (HTTP SSE planned)
- π OpenProject API Integration: Complete access to projects, work packages, and tasks
- π‘οΈ Security: Encrypted configuration and API key management
- π₯οΈ CLI Interface: Comprehensive command-line tools
- π― MCP Compatible: Works with Windsurf, and other MCP clients
- β Production Tested: Verified installation and CLI functionality
CLI Commands
# 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
Available MCP Tools
- Project Management: List projects, get project details, project statistics
- Work Packages: Create, read, update work packages and tasks
- Weekly Reports: Generate weekly reports for projects
- Time Tracking: Log time entries, track project hours
- Team Management: Access user information and team assignments
Architecture
This project uses a comprehensive architecture with:
- MCP Server: FastMCP-based implementation with multiple transport modes
- OpenProject Integration: Generated API client with full OpenProject support
- Security Framework: Encrypted configuration and API key management
- CLI Interface: Comprehensive command-line tools for all operations
Key Components
mcp_server/: Core MCP server implementationpyproject.toml: Project configuration with comprehensive dependency management #-smithery.yaml: Smithery platform deployment configuration
Transport Modes
β Stdio Mode (Recommended for MCP Clients)
- Use Case: Direct integration with Claude Code, Windsurf, and other MCP clients
- Command:
mcp-openproject server --stdio - Benefits: Standard MCP protocol, low latency, secure
π§ HTTP Mode (Planned)
- Use Case: Web applications, HTTP API integration
- Command:
mcp-openproject server --http --port 8000 - Benefits: RESTful API, web-friendly, CORS support
π§ SSE Mode (Planned)
- Status: Planned for future release
- Use Case: Real-time updates, streaming responses
- Command:
mcp-openproject server --sse --port 8001(future)
License
MIT License - see LICENSE file for details.\
Changelog
See CHANGELOG.md for version history and updates.
