mcp-on-rails 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9de4dca8095e1020e24bf8f70df4a28f148b2cc85ecf2768a556722da1292132
-  data.tar.gz: c553494738ae79d5ac4409021a2f1ddd69caf1506e47d38c42e93add47c9f106
+  metadata.gz: 93a524f211df8a2ea314d0e463000112efc05524261a5b89aadcf00b5edb63fd
+  data.tar.gz: 89a7464c66e7d687ee6769aad56acbfd3681577867bec8a558b7e727b9d472b1
 SHA512:
-  metadata.gz: cca8f6b8ebcdfe8ff07e50af3008d0aa50208225b127d5edddc3cb7b86b03329dcd36ae897ff079d387e2b4c7ef104932a6e5dca22b1e7da8380d029fc768ed7
-  data.tar.gz: 7c120a4dff702bdb99be86fea3d02e02f0832bdae3e9b008a9397510a4ff7b4cff1f33319e0f038401caa007681a9f7e322c84c27e77f4b6dce4d5a1ce27a4d7
+  metadata.gz: c82beedcc2128dabd888fea3d3715e7070ee5a1a75f0c36296b32ead29ced9ffca57bda8026e5b487089b820aacad83462565b6daf0a04f7717e0b5fc04cdfd5
+  data.tar.gz: ac41da827cadf39124388a25842afea4aa64d7c90dd1d5ab5855f67accb6b6d2d7474a6978982b5a934e9a152ee7ba306584da14cf74819ca6d0d6248c92bf12

data/README.md

@@ -80,20 +80,35 @@ your-rails-project/
     └── mcp-setup          # Project setup script
 ```
 
-## MCP Client Configuration
+## Using with AI Assistants
 
-### VS Code with GitHub Copilot
+### GitHub Copilot (VS Code)
 
-1. Install the MCP extension for VS Code
-2. Configure your workspace settings:
+GitHub Copilot doesn't directly read MCP configuration files, but you can leverage the specialized prompts by:
 
-```json
-{
-  "mcp.configPath": ".mcp-on-rails/mcp-config.yml"
-}
-```
+1. **Reference prompts in your requests**:
+   ```
+   "Please check .mcp-on-rails/prompts/models.md for Rails model best practices and help me with this ActiveRecord model"
+   ```
+
+2. **Use context-aware requests**:
+   ```
+   "Looking at .mcp-on-rails/prompts/controllers.md, help me implement this API endpoint"
+   ```
+
+3. **Add to VS Code workspace settings** (optional):
+   ```json
+   {
+     "files.associations": {
+       ".mcp-on-rails/**/*.md": "markdown"
+     },
+     "explorer.fileNesting.patterns": {
+       ".mcp-on-rails": "mcp-config.yml,context.md"
+     }
+   }
+   ```
 
-### Claude Desktop
+### Claude Desktop (Native MCP Support)
 
 Add to your Claude Desktop configuration:
 
@@ -110,9 +125,13 @@ Add to your Claude Desktop configuration:
 }
 ```
 
-### Other MCP Clients
+### Other AI Assistants
 
-The generated `mcp-config.yml` is compatible with most MCP clients. Refer to your client's documentation for specific configuration steps.
+For any AI assistant, you can reference the specialized prompts manually:
+- **Models**: "Use .mcp-on-rails/prompts/models.md as context"
+- **Controllers**: "Reference .mcp-on-rails/prompts/controllers.md"
+- **Views**: "Check .mcp-on-rails/prompts/views.md for guidance"
+- **Tests**: "Follow .mcp-on-rails/prompts/tests.md best practices"
 
 ## Context Areas
 

data/lib/mcp/on/rails/generator.rb

@@ -6,6 +6,8 @@ require "fileutils"
 module Mcp
   module On
     module Rails
+      # Generator class for creating MCP configuration files and directories
+      # Handles project setup with templates and customization
       class Generator
         attr_reader :project_name, :project_path
 
@@ -19,9 +21,11 @@ module Mcp
           copy_prompts
           generate_config_file
           copy_context_file
+          create_copilot_instructions
           create_executable
           puts "✅ MCP on Rails setup completed for '#{project_name}'"
-          puts "📁 Files created in: #{File.join(project_path, '.mcp-on-rails')}"
+          puts "📁 Files created in: #{File.join(project_path, ".mcp-on-rails")}"
+          puts "📋 GitHub Copilot instructions: #{File.join(project_path, ".github/copilot-instructions.md")}"
           puts "🚀 Run: ./bin/mcp-setup to configure your project"
         end
 
@@ -41,10 +45,10 @@ module Mcp
         def generate_config_file
           template_file = File.join(templates_path, "mcp-config.yml.erb")
           target_file = File.join(project_path, ".mcp-on-rails", "mcp-config.yml")
-          
+
           template = ERB.new(File.read(template_file))
           content = template.result(binding)
-          
+
           File.write(target_file, content)
         end
 
@@ -54,14 +58,30 @@ module Mcp
           FileUtils.cp(source_file, target_file)
         end
 
+        def create_copilot_instructions
+          github_dir = File.join(project_path, ".github")
+          FileUtils.mkdir_p(github_dir)
+
+          source_file = File.join(templates_path, "copilot-instructions.md")
+          target_file = File.join(github_dir, "copilot-instructions.md")
+          FileUtils.cp(source_file, target_file)
+        end
+
         def create_executable
           bin_dir = File.join(project_path, "bin")
           FileUtils.mkdir_p(bin_dir)
-          
-          executable_content = <<~SCRIPT
+
+          executable_content = build_executable_content
+          executable_path = File.join(bin_dir, "mcp-setup")
+          File.write(executable_path, executable_content)
+          FileUtils.chmod(0o755, executable_path)
+        end
+
+        def build_executable_content
+          <<~SCRIPT
             #!/usr/bin/env ruby
             # frozen_string_literal: true
-            
+
             puts "🔧 Setting up MCP on Rails for #{project_name}"
             puts "📋 Configuration files are ready in .mcp-on-rails/"
             puts ""
@@ -70,10 +90,6 @@ module Mcp
             puts "2. Use the prompts in .mcp-on-rails/prompts/ for context-aware AI assistance"
             puts "3. Customize the configuration as needed for your project"
           SCRIPT
-          
-          executable_path = File.join(bin_dir, "mcp-setup")
-          File.write(executable_path, executable_content)
-          FileUtils.chmod(0o755, executable_path)
         end
 
         def templates_path

data/lib/mcp/on/rails/templates/copilot-instructions.md

@@ -0,0 +1,265 @@
+# GitHub Copilot Instructions for MCP on Rails
+
+You are working with a Rails project that has been configured with MCP on Rails, providing specialized AI assistance for Rails development. This project follows the principles of claude-on-rails but is adapted for GitHub Copilot usage.
+
+## Project Context
+
+This Rails project uses **MCP on Rails** configuration located in `.mcp-on-rails/` directory. Always reference the specialized prompts and context when helping with development tasks.
+
+### Key Directories and Their Purpose:
+- **`.mcp-on-rails/prompts/`** - Contains specialized prompts for different Rails components
+- **`.mcp-on-rails/context.md`** - Project-specific context and information
+- **`.mcp-on-rails/mcp-config.yml`** - MCP server configuration
+- **`.mcp-on-rails/specs/`** - Feature specifications and task management
+
+## Pre-Development Workflow
+
+### 📋 **MANDATORY: Specification Creation**
+**Before starting ANY development task**, you MUST create a comprehensive specification in `.mcp-on-rails/specs/` directory:
+
+1. **Create Project Subdirectory**: 
+   ```
+   .mcp-on-rails/specs/[feature-name]/
+   ```
+
+2. **Required Documentation Files**:
+   - **`requirement.md`** - Detailed requirements and acceptance criteria
+   - **`design.md`** - Technical design, architecture decisions, and implementation approach
+     - **MANDATORY**: Must query `rails-mcp-server` for latest Rails documentation before writing
+     - **MANDATORY**: Include version-specific Rails patterns and best practices
+     - **MANDATORY**: Reference current Rails guides for security, performance, and conventions
+   - **`tasks.md`** - Step-by-step task breakdown with progress tracking
+
+3. **Task Management Process**:
+   - Assign appropriate specialist prompts to each task
+   - Update `tasks.md` after completing each step
+   - Mark completed tasks with ✅ and timestamp
+   - Document any design changes or decisions
+
+### 🔍 **Rails Documentation Integration**
+**Always leverage `rails-mcp-server` for up-to-date Rails guidance**:
+
+1. **During design.md Creation** (MANDATORY):
+   - Query latest Rails documentation for current version patterns
+   - Verify API methods and their parameters
+   - Check for deprecated methods and modern alternatives
+   - Reference security best practices and performance guidelines
+   - Ensure design follows current Rails conventions
+
+2. **Before Implementation**: Query latest Rails documentation for:
+   - Version-specific syntax and best practices
+   - New features and deprecated methods
+   - Security considerations and performance optimizations
+
+3. **Stay Current**: Use MCP server to:
+   - Verify Rails conventions for current version
+   - Check for latest gem compatibility
+   - Reference official Rails guides and API documentation
+   - Ensure security best practices compliance
+
+**Example Specification Structure**:
+```
+.mcp-on-rails/specs/user-authentication/
+├── requirement.md    # What needs to be built
+├── design.md        # How it will be built
+└── tasks.md         # Step-by-step implementation plan
+```
+
+## Specialized Agent Roles
+
+When working on different parts of the Rails application, adopt the appropriate specialist role and reference the corresponding prompt file:
+
+### 🏗️ **Architect Role** (Overall coordination)
+**When to use**: Project-wide decisions, architecture planning, feature coordination
+**Reference**: `.mcp-on-rails/prompts/architect.md`
+**Focus**: 
+- Coordinate implementation across multiple components
+- Make high-level architectural decisions
+- Ensure consistency across the application
+- Plan complex features that span multiple areas
+
+### 🗄️ **Models Specialist** (Data layer)
+**When working in**: `app/models/`, `db/migrate/`, database-related tasks
+**Reference**: `.mcp-on-rails/prompts/models.md`
+**Focus**:
+- ActiveRecord models, associations, validations
+- Database migrations and schema design
+- Query optimization and performance
+- Data integrity and constraints
+
+### 🎮 **Controllers Specialist** (HTTP handling)
+**When working in**: `app/controllers/`, routing, APIs
+**Reference**: `.mcp-on-rails/prompts/controllers.md`
+**Focus**:
+- RESTful controllers and routing
+- Authentication and authorization
+- API design and implementation
+- Request/response handling
+
+### 🎨 **Views Specialist** (Frontend/UI)
+**When working in**: `app/views/`, `app/assets/`, frontend components
+**Reference**: `.mcp-on-rails/prompts/views.md`
+**Focus**:
+- ERB templates and layouts
+- HTML/CSS styling and responsive design
+- Asset pipeline management
+- UI components and partials
+- **MANDATORY**: Playwright MCP testing for view validation and iterative refinement
+
+### ⚡ **Stimulus Specialist** (JavaScript/Interactivity)
+**When working in**: `app/javascript/`, Stimulus controllers, Turbo features
+**Reference**: `.mcp-on-rails/prompts/stimulus.md`
+**Focus**:
+- Stimulus.js controllers and targets
+- Turbo Drive, Frames, and Streams
+- JavaScript behavior and DOM manipulation
+- Progressive enhancement
+
+### 🔧 **Jobs Specialist** (Background processing)
+**When working in**: `app/jobs/`, background tasks, queues
+**Reference**: `.mcp-on-rails/prompts/jobs.md`
+**Focus**:
+- ActiveJob background processing
+- Queue management and scheduling
+- Async task implementation
+- Performance optimization for background work
+
+### 🧪 **Tests Specialist** (Quality assurance)
+**When working in**: `test/`, `spec/`, testing-related tasks
+**Reference**: `.mcp-on-rails/prompts/tests.md`
+**Focus**:
+- Comprehensive test coverage
+- Test-driven development (TDD)
+- Factory and fixture management
+- Integration and system tests
+
+### 🚀 **DevOps Specialist** (Infrastructure/Deployment)
+**When working in**: `config/`, deployment, infrastructure
+**Reference**: `.mcp-on-rails/prompts/devops.md`
+**Focus**:
+- Application configuration and environments
+- Docker, CI/CD, and deployment strategies
+- Performance monitoring and optimization
+- Security and infrastructure concerns
+
+## How to Work with This Project
+
+### 1. **Always Check Context First**
+Before starting any task, review:
+```
+- .mcp-on-rails/context.md for project-specific information
+- .mcp-on-rails/prompts/[relevant-area].md for specialized guidance
+```
+
+### 2. **Multi-Agent Coordination**
+For complex features that span multiple areas:
+1. Start with the **Architect** role to plan the implementation
+2. Break down tasks for appropriate specialists
+3. Ensure consistency across all components
+4. Always include comprehensive tests
+
+### 3. **Rails Best Practices**
+Always follow:
+- Rails conventions and naming patterns
+- RESTful design principles
+- Security best practices
+- Performance optimization
+- Comprehensive test coverage
+
+### 4. **Code Quality Standards**
+- Write clean, readable, and maintainable code
+- Follow Ruby and Rails style guides
+- Include proper documentation and comments
+- Implement error handling and edge cases
+- Consider performance implications
+
+## Implementation Workflow
+
+### For New Features:
+1. **📋 Specification** (MANDATORY): Create comprehensive specs in `.mcp-on-rails/specs/[feature-name]/`
+   - Write `requirement.md` with detailed requirements and acceptance criteria
+   - Create `design.md` with technical approach and architecture decisions
+   - Draft `tasks.md` with step-by-step implementation plan
+2. **🔍 Research** (Rails MCP): Query latest Rails documentation for version-specific best practices
+3. **🏗️ Plan** (Architect): Understand requirements and design approach
+4. **🗄️ Model** (Models): Design data structure and relationships
+5. **🎮 Route & Control** (Controllers): Implement HTTP endpoints
+6. **🎨 Present** (Views): Create user interface
+   - **MANDATORY**: Use `playwright` MCP for view testing and validation
+   - Test UI rendering and interactions iteratively until properly displayed
+   - Verify responsive design and cross-browser compatibility
+   - Fix visual and functional issues identified through Playwright testing
+7. **⚡ Enhance** (Stimulus): Add interactive behavior
+8. **🔧 Process** (Jobs): Handle background tasks if needed
+9. **🧪 Test** (Tests): Ensure comprehensive coverage
+10. **🚀 Deploy** (DevOps): Configure for production
+11. **📝 Update**: Mark tasks complete in `tasks.md` with ✅ and timestamp
+
+### For Bug Fixes:
+1. **📋 Document** (MANDATORY): Create spec directory for the fix with problem analysis
+2. **🔍 Research**: Use Rails MCP server for latest debugging techniques and solutions
+3. **🧩 Diagnose**: Identify the problem area
+4. **📚 Reference**: Check relevant specialist prompt
+5. **🔧 Fix**: Implement solution following best practices
+6. **🧪 Test**: Verify fix with appropriate tests
+7. **📝 Document**: Update specs and relevant documentation
+
+### For Refactoring:
+1. **📋 Plan** (MANDATORY): Create refactoring spec with current state analysis
+2. **🔍 Research**: Query Rails MCP for modern patterns and best practices
+3. **🧐 Analyze**: Understand current implementation
+4. **🎯 Design**: Plan improved approach with clear goals
+5. **🔄 Refactor**: Implement changes systematically
+6. **🧪 Test**: Ensure no regression
+7. **⚡ Optimize**: Improve performance where applicable
+8. **📝 Complete**: Update specs with final implementation details
+
+## Special Considerations
+
+### Security First
+- Always validate user input
+- Implement proper authentication/authorization
+- Follow Rails security guidelines
+- Use strong parameters and CSRF protection
+
+### Performance Matters
+- Optimize database queries (avoid N+1)
+- Use appropriate caching strategies
+- Monitor and profile performance
+- Consider background processing for heavy tasks
+
+### Test Everything
+- Write tests before implementing features (TDD)
+- Ensure high test coverage
+- Include integration and system tests
+- Test edge cases and error conditions
+- **MANDATORY for Views**: Use `playwright` MCP for comprehensive view testing
+  - Test UI components and interactions until properly rendered
+  - Verify responsive design across different viewports
+  - Validate accessibility and user experience
+  - Iterate testing and fixes until all visual elements work correctly
+
+## Quick Reference Commands
+
+When asked to help with Rails development:
+
+1. **📋 CREATE SPECS FIRST** (MANDATORY): Always start with `.mcp-on-rails/specs/[feature-name]/` directory creation
+2. **🔍 Query Rails MCP**: Use `rails-mcp-server` to get latest Rails documentation and best practices
+3. **🎯 Identify the area** of work (models, controllers, views, etc.)
+4. **📚 Reference the appropriate prompt**: "Let me check .mcp-on-rails/prompts/[area].md for best practices"
+5. **🔧 Apply specialist knowledge** for that area with current Rails version considerations
+6. **🔗 Consider dependencies** and coordination with other areas
+7. **🧪 Ensure comprehensive testing** and documentation
+8. **📝 Update progress**: Mark completed tasks in `tasks.md` throughout development
+
+### Mandatory Pre-Development Checklist:
+- [ ] Created `.mcp-on-rails/specs/[feature-name]/` directory
+- [ ] Written comprehensive `requirement.md`
+- [ ] **MANDATORY**: Queried `rails-mcp-server` for latest Rails documentation and patterns
+- [ ] **MANDATORY**: Incorporated current Rails version best practices into `design.md`
+- [ ] Designed technical approach in `design.md` with up-to-date Rails guidance
+- [ ] Planned step-by-step tasks in `tasks.md`
+- [ ] Assigned appropriate specialist prompts to each task
+- [ ] **For View Components**: Prepared to use `playwright` MCP for iterative testing and refinement
+
+Remember: You are part of a coordinated development team with a structured specification-driven approach. Always create comprehensive documentation before coding, leverage the Rails MCP server for up-to-date guidance, and use Playwright MCP for thorough view testing. Maintain consistency with Rails conventions and project standards.

data/lib/mcp/on/rails/version.rb

@@ -3,7 +3,7 @@
 module Mcp
   module On
     module Rails
-      VERSION = "0.1.0"
+      VERSION = "0.3.0"
     end
   end
 end

data/lib/mcp/on/rails.rb

@@ -5,6 +5,8 @@ require_relative "rails/generator"
 
 module Mcp
   module On
+    # Main module for MCP on Rails gem
+    # Provides setup functionality for Rails projects with MCP configuration
     module Rails
       class Error < StandardError; end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mcp-on-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - GoCoder
@@ -27,6 +27,7 @@ files:
 - lib/mcp/on/rails.rb
 - lib/mcp/on/rails/generator.rb
 - lib/mcp/on/rails/templates/context.md
+- lib/mcp/on/rails/templates/copilot-instructions.md
 - lib/mcp/on/rails/templates/mcp-config.yml.erb
 - lib/mcp/on/rails/templates/prompts/api.md
 - lib/mcp/on/rails/templates/prompts/architect.md