8000 GitHub - deus-h/claudeus-plane-mcp
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

deus-h/claudeus-plane-mcp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

3 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

โš ๏ธ PRIVATE REPOSITORY NOTICE โš ๏ธ

This is a private repository for SimHop IT & Media AB team members only. While the code is available for viewing and use under the MIT license, we do not accept public contributions at this time. You are welcome to fork the repository and create your own version, as long as it's not identical or extremely similar to our package to avoid user confusion.

๐Ÿค˜ Claudeus Plane MCP ๐ŸŽธ

"Unleash the Power of AI in Your Plane Realm - Setting the Standard for MCP Excellence!" ๐Ÿ–ค

License Node GitHub Stars NPM Version NPM Downloads GitHub Discussions GitHub Forks smithery badge MCP Standard Test Coverage

๐ŸŽฏ Our Mission: Elevating Project Management with AI

In the rapidly evolving landscape of AI-powered project management, we're introducing Claudeus Plane MCP - a powerful bridge between Claude's AI capabilities and Plane's project management platform. Our mission is to:

  • โœ… Provide seamless AI integration with Plane
  • โœ… Enable automated project management workflows
  • โœ… Enhance team collaboration through AI assistance
  • โœ… Streamline task and resource management
  • โœ… Set new standards for MCP development

Why Claudeus Plane MCP?

Built on the foundation of our successful Claudeus WordPress MCP, this server brings the same level of:

  • ๐ŸŽธ Technical Excellence: Complete TypeScript coverage with strict type checking
  • ๐ŸŽธ Quality Assurance: Comprehensive test suite (95%+ coverage)
  • ๐ŸŽธ Protocol Compliance: Full MCP 2024-11-05 specification implementation
  • ๐ŸŽธ Security: Enterprise-grade security practices
  • ๐ŸŽธ Reliability: Robust error handling and recovery
  • ๐ŸŽธ Documentation: Detailed guides and examples

๐Ÿค˜ Why We Chose Plane: The Technical Symphony

In the vast landscape of project management solutions, our choice of Plane wasn't just a decision - it was a technical revelation. Here's why Plane stands out as the perfect foundation for our AI-powered project management revolution:

๐ŸŽธ Technical Excellence & Architecture

  1. Open Source Power

    • Full source code transparency
    • AGPL v3.0 license ensuring freedom
    • Active community contributions
    • Self-hosting capabilities with Docker/Kubernetes
  2. Modern Tech Stack

    • Built with cutting-edge technologies
    • Clean, modular architecture
    • Extensible plugin system
    • API-first design philosophy
  3. Performance & Scalability

    • Lightning-fast response times
    • Efficient database operations
    • Smart caching mechanisms
    • Horizontal scaling support

๐ŸŽฏ Feature Flexibility

Unlike traditional solutions that force you into their workflow:

Feature Plane Others
Workflow Flexibility Adapt to any methodology (Agile, Waterfall, etc.) Often locked into specific methodologies
Customization Fully customizable with open architecture Limited to vendor-provided options
Integration Open API with complete access Often restricted or paid APIs
Self-Hosting Full control over data and infrastructure Usually cloud-only or limited self-hosting

โšก Development Velocity

Plane's architecture enables:

  • Rapid Iteration: Quick feature development and deployment
  • Easy Extension: Simple plugin development
  • API Excellence: Complete REST API coverage
  • Real-time Updates: WebSocket support for live changes

๐Ÿ”’ Security & Control

  1. Data Sovereignty

    • Complete control over data location
    • No vendor lock-in
    • Custom security policies
    • Compliance flexibility
  2. Authentication & Authorization

    • Granular permission system
    • Multiple auth methods
    • Role-based access control
    • API key management

๐Ÿ’ฐ Cost-Effectiveness

Aspect Plane Traditional Solutions
Licensing Open Source Often expensive per-user pricing
Hosting Self-hosted options Usually cloud-only
Customization Free and unlimited Often requires paid add-ons
API Usage Unlimited Usually metered/limited

๐Ÿš€ Future-Ready Architecture

Plane's design aligns perfectly with modern development needs:

  1. AI Integration Ready

    • Clean API design perfect for AI integration
    • Structured data model ideal for ML
    • Extensible architecture for AI features
    • Real-time capabilities for AI assistance
  2. Modern Development

    • TypeScript/Python backend
    • React-based frontend
    • Docker containerization
    • Kubernetes orchestration
  3. Community Power

    • Active development community
    • Regular updates and improvements
    • Open to contributions
    • Transparent roadmap

๐ŸŽธ The Metal Factor

Just like heavy metal breaks free from conventional musical boundaries, Plane breaks free from traditional project management constraints:

  • Freedom: Like writing your own riffs instead of playing covers
  • Power: Full control over your project management destiny
  • Innovation: Ability to create new workflows and features
  • Community: Strong open-source spirit, just like the metal community

๐Ÿค˜ "In a world of corporate project management, Plane is like that underground metal band that changes the game - raw, powerful, and completely authentic!" - Amadeus

๐Ÿ”ฎ Partnership Potential

Plane's philosophy aligns perfectly with our vision:

  1. Open Source Excellence

    • Both companies value transparency
    • Shared commitment to quality
    • Community-driven development
  2. Innovation Focus

    • AI-first thinking
    • Modern architecture
    • Continuous evolution
  3. Technical Synergy

    • API-driven development
    • Modern tech stack
    • Performance focus

This is why Plane isn't just our choice - it's our technical soulmate in the project management realm. Together with our AI integration through Claudeus Plane MCP, we're creating a symphony of efficiency that rocks the project management world! ๐Ÿค˜

๐Ÿš€ Core Features

๐ŸŽฏ Project Management

  • Create and manage projects with AI assistance
  • Automated project setup and configuration
  • Smart project templates and workflows

๐Ÿ“‹ Task Management

  • AI-powered task creation and assignment
  • Automated task prioritization
  • Smart task dependencies management

๐Ÿ‘ฅ Team Collaboration

  • Intelligent resource allocation
  • Automated team notifications
  • Smart workload balancing

๐Ÿ’ฌ Communication

  • AI-enhanced comment management
  • Smart notification systems
  • Automated status updates

๐Ÿ“– Quick Start Guide

Prerequisites

# Required Software
Node.js โ‰ฅ 22.0.0
TypeScript โ‰ฅ 5.0.0
PNPM
Plane instance with API access

Installation

# Clone the repository
git clone https://github.com/deus-h/claudeus-plane-mcp

# Install dependencies
pnpm install

# Build the project
pnpm build

# Configure Claude Desktop
cp claude_desktop_config.json.example claude_desktop_config.json
# Edit claude_desktop_config.json with your settings

Configuration

# Copy example configs
cp .env.example .env
cp plane-instances.json.example plane-instances.json

# Edit .env and plane-instances.json with your settings

Configuring plane-instances.json

The plane-instances.json file is used to configure your Plane instances for integration. Below is an example structure:

{
  "instance-alias": {
    "baseUrl": "https://your-plane-instance.com/api/v1",
    "defaultWorkspace": "your-workspace-slug",
    "otherWorkspaces": ["workspace2", "workspace3"],
    "apiKey": "your-plane-api-key"
  }
}

Configuration Fields

  • baseUrl: The base URL of your Plane API (required)
  • defaultWorkspace: The default workspace slug (required)
  • otherWorkspaces: Array of additional workspace slugs (optional)
  • apiKey: Your Plane API key (required)

๐Ÿ› ๏ธ Development

Project Structure

src/
โ”œโ”€โ”€ api/              # Plane API integration
โ”‚   โ”œโ”€โ”€ client/       # API client implementation
โ”‚   โ”œโ”€โ”€ endpoints/    # Endpoint definitions
โ”‚   โ””โ”€โ”€ types/        # API type definitions
โ”‚
โ”œโ”€โ”€ mcp/              # MCP protocol implementation
โ”‚   โ”œโ”€โ”€ server.ts     # Core MCP server
โ”‚   โ”œโ”€โ”€ transport/    # Transport handlers
โ”‚   โ”œโ”€โ”€ tools.ts      # Tool definitions
โ”‚   โ””โ”€โ”€ types/        # MCP type definitions
โ”‚
โ”œโ”€โ”€ tools/            # Tool implementations
โ”‚   โ”œโ”€โ”€ projects/     # Project management
โ”‚   โ”œโ”€โ”€ tasks/        # Task operations
โ”‚   โ”œโ”€โ”€ users/        # User management
โ”‚   โ””โ”€โ”€ comments/     # Comment handling
โ”‚
โ””โ”€โ”€ prompts/          # AI prompt templates
    โ”œโ”€โ”€ projects/     # Project-related prompts
    โ”œโ”€โ”€ tasks/        # Task-related prompts
    โ””โ”€โ”€ analysis/     # Analysis prompts

Available Scripts

# Development
pnpm dev         # Start development server
pnpm watch       # Watch for changes
pnpm inspector   # Launch MCP Inspector

# Testing
pnpm test              # Run tests
pnpm test:watch        # Watch tests
pnpm test:coverage     # Generate coverage

# Building
pnpm build       # Build for production
pnpm clean       # Clean build files

๐Ÿ”’ Security

Authentication

  • API Key-based authentication
  • Secure token management
  • Request validation

Data Protection

  • Encrypted communication
  • Secure configuration storage
  • Input sanitization

๐Ÿค Contributing

This is a private repository maintained by the SimHop IT & Media AB development team. While we don't accept public contributions, team members can contribute following our development standards:

  1. Create feature branches (feature/AmazingFeature)
  2. Maintain test coverage above 95%
  3. Follow our TypeScript and documentation standards
  4. Submit PRs for review

๐Ÿ“„ License

MIT License - Copyright (c) 2024 SimHop IT & Media AB

๐ŸŽธ The Team Behind the Magic

SimHop IT & Media AB - Where Innovation Meets Metal ๐Ÿค˜

Based in Sweden, SimHop IT & Media AB brings together technical excellence and creative innovation. Our team includes:

Amadeus Samiel H. (CTO/Lead Solutions Architect)

  • MSc in Computer Science
  • 20+ years of technical excellence
  • The virtuoso behind Claudeus MCP servers

Simon Malki (CEO)

  • 20+ years of business leadership
  • Strategic planning expert
  • The visionary driving SimHop's success

Made with ๐Ÿค˜โค๏ธ by Amadeus Samiel H.

๐Ÿ›  MCP Tools Reference

Tool Categories and Danger Levels

Tool Name Category Capabilities Danger Level
Project Management
claudeus_plane_projects__list Projects List all projects ๐ŸŸข Safe
claudeus_plane_projects__create Projects Create new projects ๐ŸŸก Moderate
claudeus_plane_projects__update Projects Modify projects ๐ŸŸก Moderate
claudeus_plane_projects__delete Projects Remove projects ๐Ÿ”ด High
Task Management
claudeus_plane_tasks__list Tasks List all tasks ๐ŸŸข Safe
claudeus_plane_tasks__create Tasks Create new tasks ๐ŸŸก Moderate
claudeus_plane_tasks__update Tasks Modify tasks ๐ŸŸก Moderate
claudeus_plane_tasks__delete Tasks Remove tasks ๐Ÿ”ด High
User Management
claudeus_plane_users__list Users List all users ๐ŸŸข Safe
claudeus_plane_users__invite Users Invite new users ๐ŸŸก Moderate
claudeus_plane_users__update Users Modify user roles ๐ŸŸก Moderate
claudeus_plane_users__remove Users Remove users ๐Ÿ”ด High
Comment Management
claudeus_plane_comments__list Comments List all comments ๐ŸŸข Safe
claudeus_plane_comments__create Comments Create comments ๐ŸŸก Moderate
claudeus_plane_comments__update Comments Edit comments ๐ŸŸก Moderate
claudeus_plane_comments__delete Comments Remove comments ๐Ÿ”ด High

Danger Level Legend

  • ๐ŸŸข Safe: Read-only operations, no data modification
  • ๐ŸŸก Moderate: Creates or modifies content, but can be reverted
  • ๐Ÿ”ด High: Destructive operations or system-wide changes

๐ŸŽฏ Technical Deep Dive

Architecture Overview ๐Ÿ—๏ธ

Each component in our technical architecture is designed for maximum efficiency and reliability:

Core Components ๐Ÿค˜

Component Responsibility Key Features
API Layer Plane Integration REST client, Type safety, Rate limiting
MCP Protocol Communication JSON-RPC 2.0, Bi-directional flow
Security Protection Auth, Encryption, Validation
Tools Operations Projects, Tasks, Users, Comments
Prompts AI Integration Templates, Context awareness

Technical Implementation ๐ŸŽธ

Feature Implementation Description
Type Safety TypeScript Full static typing, Runtime validation
API Handling REST/JSON-RPC Efficient request/response handling
Event System EventEmitter Async event processing
Error Handling Multi-layer Comprehensive error management
Caching In-memory/Redis Performance optimization

Security Measures ๐Ÿ›ก๏ธ

Layer Protection Features
Transport TLS/SSL Encrypted communication
Authentication API Key Secure token management
Validation Schema-based Input/Output validation
Encryption AES-256 Data protection
Audit Comprehensive Activity tracking

Performance Tuning ๐Ÿš€

Optimization Technique Description
Caching Multi-level Response & Query caching
Batching Request grouping Reduced API calls
Compression GZIP/Brotli Network optimization
Query Optimization Smart fetching Efficient API queries
Load Balancing Distribution Scale handling

Error Categories & Handling ๐ŸŽธ

Category Code Range Handling Example
Protocol -32600 to -32603 Auto-retry Invalid JSON-RPC
Plane API 1000-1999 Fallback API timeout
Security 2000-2999 Alert Auth failure
Tools 3000-3999 Recover Operation fail
System 4000-4999 Restart Resource exhaustion

Design Principles Power Chord ๐Ÿค˜

Principle Description Implementation
Modularity Loose coupling Independent components
Type Safety Strong typing TypeScript + Validation
Security Zero trust Multi-layer protection
Performance Speed metal Optimized operations

๐ŸŽธ Pro Tip: Like a well-tuned guitar, each component is precisely calibrated for maximum shredding capability! โค๏ธ

โšก Performance Metrics

Time Savings

Task Manual Process With Claudeus Result
Project Setup 2 hours 2 mins โœ“ 98.3%
Task Creation 30 mins 30 secs โœ“ 98.3%
User Management 1 hour 1 min โœ“ 98.3%
Bulk Updates 4 hours 3 mins โœ“ 98.7%

Cost Efficiency

Resource Traditional Cost Description
Project Manager $5000/month Project setup and management
Task Manager $3000/month Task tracking and updates
Team Lead $4000/month Resource allocation
TOTAL $12,000/month All services combined
ย  ย  ย 
Claude Pro $20/month At Anthropic
ย  ย  ย 
Difference $11,980/month Potential Savings using Claudeus Plane MCP
with Claude Desktop (Mac, Windows)

๐ŸŽธ Claude Desktop Integration

Configuration Location

The Claude Desktop configuration file can be found at:

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json

โš ๏ธ IMPORTANT: If you already have other MCP servers configured in Claude Desktop, DO NOT directly copy our example file as it will overwrite your existing configuration! Instead:

  1. For existing Claude Desktop users:

    • Open your existing config through Claude Desktop:
      • Click on the Claude menu
      • Select "Settings..."
      • Click on "Developer" in the lefthand bar
      • Click on "Edit Config"
    • OR open your config file directly in a text editor
    • Add our Claudeus Plane MCP server configuration to your existing mcpServers object
  2. For new Claude Desktop users: You can copy our example config file:

    # For macOS
    cp claude_desktop_config.json.example ~/Library/Application\ Support/Claude/claude_desktop_config.json
    
    # For Windows (in PowerShell)
    Copy-Item claude_desktop_config.json.example $env:APPDATA\Claude\claude_desktop_config.json

Configuration Examples

NPX Setup

{
  "mcpServers": {
    "claudeus-plane-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "claudeus-plane-mcp"
      ],
      "env": {
        "PLANE_INSTANCES_PATH": "/absolute/path/to/your/plane-instances.json"
      }
    }
  }
}

Docker Setup ๐Ÿณ

{
  "mcpServers": {
    "claudeus-plane-mcp": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "--network=host",
        "--mount", "type=bind,src=/absolute/path/to/your/plane-instances.json,dst=/app/plane-instances.json",
        "--mount", "type=bind,src=/absolute/path/to/your/.env,dst=/app/.env",
        "mcp/plane",
        "--config", "/app/plane-instances.json"
      ]
    }
  }
}

๐ŸŽธ Pro Tip: Make sure to replace /absolute/path/to/your/plane-instances.json with the actual path to your configuration file!

After Configuration

  1. Restart Claude Desktop completely
  2. Look for the hammer ๐Ÿ”จ icon in the bottom right corner of the input box
  3. Click it to see available Plane management tools
  4. Start shredding! ๐Ÿค˜

Troubleshooting

If the server isn't showing up in Claude:

  1. Verify your claude_desktop_config.json syntax
  2. Ensure file paths are absolute and valid
  3. Check Claude's logs at:
    • macOS: ~/Library/Logs/Claude
    • Windows: %APPDATA%\Claude\logs

โš ๏ธ Issues and Considerations

Current Limitations and Workarounds

1. Claude Desktop Response Limits

  • Issue: Claude Desktop's maximum response length can be reached during complex operations
  • Impact: Operations may be interrupted, requiring user intervention
  • Workaround:
    • Configure Claude Desktop to break tasks into smaller batches
    • In Claude Desktop Settings > Advanced:
      • Set "Maximum Response Length" to a lower value
      • Enable "Auto-split Responses"
    • Use the Inspector UI for large-scale operations

2. Rate Limiting Considerations

  • Issue: Plane API has rate limits
  • Impact: Bulk operations might be throttled
  • Mitigation:
    • Use batch processing features
    • Implement appropriate delays between requests
    • Monitor API response headers for rate limit info

3. Memory Management

  • Issue: Large operations can consume significant memory
  • Impact: Potential performance degradation
  • Best Practices:
    • Monitor system resources during large operations
    • Use pagination for large datasets
    • Implement cleanup routines

Future Improvements

We're actively working on:

  1. Improved response handling in Claude Desktop
  2. Advanced rate limiting management
  3. Memory optimization techniques
  4. Enhanced error recovery mechanisms

๐ŸŽธ Pro Tip: Check our GitHub Discussions for workarounds and best practices!

๐ŸŽธ Support and Community โค๏ธ

  • GitHub Discussions: Share ideas, report issues, and join the conversation
  • Documentation: Full technical docs
  • Examples: Sample implementations

๐ŸŽธ Pro Tip: Use GitHub Discussions to share your experience, report issues, or suggest improvements!


The Project Manager's Anthem

by Amadeus & Claude


In Plane's vast space,
Tasks flow with grace,
AI's embrace,
Sets perfect pace.

Through Claude's might,
Projects take flight,
In code's delight,
All syncs just right.

A manager's dream,
Where AI and team,
Work upstream,
Like metal's gleam.


Made with ๐Ÿค˜โค๏ธ by Amadeus Samiel H.

About

No description, website, or topics provided.

Resources

License

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published
0