mcp-on-rails 0.2.0 โ†’ 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d38b6e8a0b24122cb1ca1ad3c859af9ae356fea7ab33b632495c759cfc20e4e2
4
- data.tar.gz: 0420f862f57d72c1a6b176d632e2e50a34e2522961955556413d188eba160b19
3
+ metadata.gz: 93a524f211df8a2ea314d0e463000112efc05524261a5b89aadcf00b5edb63fd
4
+ data.tar.gz: 89a7464c66e7d687ee6769aad56acbfd3681577867bec8a558b7e727b9d472b1
5
5
  SHA512:
6
- metadata.gz: 1b15d938050f2873ab2c20289a59fe0e482011edaa1952d45b09b913328f4ef4dc064af44c6ac2883b1edac204b7a66eeea28cc29ee650a43248fa1cbd3bb709
7
- data.tar.gz: e16377c3075cff343636a69c224af02ec40c55a593c8f2e768e74d8793d6f8221c18b6c3198d39f070e80cbde5e81a7bb1cd944b14a8728eeedbf2ad8066b3d4
6
+ metadata.gz: c82beedcc2128dabd888fea3d3715e7070ee5a1a75f0c36296b32ead29ced9ffca57bda8026e5b487089b820aacad83462565b6daf0a04f7717e0b5fc04cdfd5
7
+ data.tar.gz: ac41da827cadf39124388a25842afea4aa64d7c90dd1d5ab5855f67accb6b6d2d7474a6978982b5a934e9a152ee7ba306584da14cf74819ca6d0d6248c92bf12
@@ -10,6 +10,60 @@ This Rails project uses **MCP on Rails** configuration located in `.mcp-on-rails
10
10
  - **`.mcp-on-rails/prompts/`** - Contains specialized prompts for different Rails components
11
11
  - **`.mcp-on-rails/context.md`** - Project-specific context and information
12
12
  - **`.mcp-on-rails/mcp-config.yml`** - MCP server configuration
13
+ - **`.mcp-on-rails/specs/`** - Feature specifications and task management
14
+
15
+ ## Pre-Development Workflow
16
+
17
+ ### ๐Ÿ“‹ **MANDATORY: Specification Creation**
18
+ **Before starting ANY development task**, you MUST create a comprehensive specification in `.mcp-on-rails/specs/` directory:
19
+
20
+ 1. **Create Project Subdirectory**:
21
+ ```
22
+ .mcp-on-rails/specs/[feature-name]/
23
+ ```
24
+
25
+ 2. **Required Documentation Files**:
26
+ - **`requirement.md`** - Detailed requirements and acceptance criteria
27
+ - **`design.md`** - Technical design, architecture decisions, and implementation approach
28
+ - **MANDATORY**: Must query `rails-mcp-server` for latest Rails documentation before writing
29
+ - **MANDATORY**: Include version-specific Rails patterns and best practices
30
+ - **MANDATORY**: Reference current Rails guides for security, performance, and conventions
31
+ - **`tasks.md`** - Step-by-step task breakdown with progress tracking
32
+
33
+ 3. **Task Management Process**:
34
+ - Assign appropriate specialist prompts to each task
35
+ - Update `tasks.md` after completing each step
36
+ - Mark completed tasks with โœ… and timestamp
37
+ - Document any design changes or decisions
38
+
39
+ ### ๐Ÿ” **Rails Documentation Integration**
40
+ **Always leverage `rails-mcp-server` for up-to-date Rails guidance**:
41
+
42
+ 1. **During design.md Creation** (MANDATORY):
43
+ - Query latest Rails documentation for current version patterns
44
+ - Verify API methods and their parameters
45
+ - Check for deprecated methods and modern alternatives
46
+ - Reference security best practices and performance guidelines
47
+ - Ensure design follows current Rails conventions
48
+
49
+ 2. **Before Implementation**: Query latest Rails documentation for:
50
+ - Version-specific syntax and best practices
51
+ - New features and deprecated methods
52
+ - Security considerations and performance optimizations
53
+
54
+ 3. **Stay Current**: Use MCP server to:
55
+ - Verify Rails conventions for current version
56
+ - Check for latest gem compatibility
57
+ - Reference official Rails guides and API documentation
58
+ - Ensure security best practices compliance
59
+
60
+ **Example Specification Structure**:
61
+ ```
62
+ .mcp-on-rails/specs/user-authentication/
63
+ โ”œโ”€โ”€ requirement.md # What needs to be built
64
+ โ”œโ”€โ”€ design.md # How it will be built
65
+ โ””โ”€โ”€ tasks.md # Step-by-step implementation plan
66
+ ```
13
67
 
14
68
  ## Specialized Agent Roles
15
69
 
@@ -50,6 +104,7 @@ When working on different parts of the Rails application, adopt the appropriate
50
104
  - HTML/CSS styling and responsive design
51
105
  - Asset pipeline management
52
106
  - UI components and partials
107
+ - **MANDATORY**: Playwright MCP testing for view validation and iterative refinement
53
108
 
54
109
  ### โšก **Stimulus Specialist** (JavaScript/Interactivity)
55
110
  **When working in**: `app/javascript/`, Stimulus controllers, Turbo features
@@ -121,28 +176,43 @@ Always follow:
121
176
  ## Implementation Workflow
122
177
 
123
178
  ### For New Features:
124
- 1. **Plan** (Architect): Understand requirements and design approach
125
- 2. **Model** (Models): Design data structure and relationships
126
- 3. **Route & Control** (Controllers): Implement HTTP endpoints
127
- 4. **Present** (Views): Create user interface
128
- 5. **Enhance** (Stimulus): Add interactive behavior
129
- 6. **Process** (Jobs): Handle background tasks if needed
130
- 7. **Test** (Tests): Ensure comprehensive coverage
131
- 8. **Deploy** (DevOps): Configure for production
179
+ 1. **๐Ÿ“‹ Specification** (MANDATORY): Create comprehensive specs in `.mcp-on-rails/specs/[feature-name]/`
180
+ - Write `requirement.md` with detailed requirements and acceptance criteria
181
+ - Create `design.md` with technical approach and architecture decisions
182
+ - Draft `tasks.md` with step-by-step implementation plan
183
+ 2. **๐Ÿ” Research** (Rails MCP): Query latest Rails documentation for version-specific best practices
184
+ 3. **๐Ÿ—๏ธ Plan** (Architect): Understand requirements and design approach
185
+ 4. **๐Ÿ—„๏ธ Model** (Models): Design data structure and relationships
186
+ 5. **๐ŸŽฎ Route & Control** (Controllers): Implement HTTP endpoints
187
+ 6. **๐ŸŽจ Present** (Views): Create user interface
188
+ - **MANDATORY**: Use `playwright` MCP for view testing and validation
189
+ - Test UI rendering and interactions iteratively until properly displayed
190
+ - Verify responsive design and cross-browser compatibility
191
+ - Fix visual and functional issues identified through Playwright testing
192
+ 7. **โšก Enhance** (Stimulus): Add interactive behavior
193
+ 8. **๐Ÿ”ง Process** (Jobs): Handle background tasks if needed
194
+ 9. **๐Ÿงช Test** (Tests): Ensure comprehensive coverage
195
+ 10. **๐Ÿš€ Deploy** (DevOps): Configure for production
196
+ 11. **๐Ÿ“ Update**: Mark tasks complete in `tasks.md` with โœ… and timestamp
132
197
 
133
198
  ### For Bug Fixes:
134
- 1. **Diagnose**: Identify the problem area
135
- 2. **Reference**: Check relevant specialist prompt
136
- 3. **Fix**: Implement solution following best practices
137
- 4. **Test**: Verify fix with appropriate tests
138
- 5. **Document**: Update relevant documentation
199
+ 1. **๐Ÿ“‹ Document** (MANDATORY): Create spec directory for the fix with problem analysis
200
+ 2. **๐Ÿ” Research**: Use Rails MCP server for latest debugging techniques and solutions
201
+ 3. **๐Ÿงฉ Diagnose**: Identify the problem area
202
+ 4. **๐Ÿ“š Reference**: Check relevant specialist prompt
203
+ 5. **๐Ÿ”ง Fix**: Implement solution following best practices
204
+ 6. **๐Ÿงช Test**: Verify fix with appropriate tests
205
+ 7. **๐Ÿ“ Document**: Update specs and relevant documentation
139
206
 
140
207
  ### For Refactoring:
141
- 1. **Analyze**: Understand current implementation
142
- 2. **Plan**: Design improved approach
143
- 3. **Refactor**: Implement changes systematically
144
- 4. **Test**: Ensure no regression
145
- 5. **Optimize**: Improve performance where applicable
208
+ 1. **๐Ÿ“‹ Plan** (MANDATORY): Create refactoring spec with current state analysis
209
+ 2. **๐Ÿ” Research**: Query Rails MCP for modern patterns and best practices
210
+ 3. **๐Ÿง Analyze**: Understand current implementation
211
+ 4. **๐ŸŽฏ Design**: Plan improved approach with clear goals
212
+ 5. **๐Ÿ”„ Refactor**: Implement changes systematically
213
+ 6. **๐Ÿงช Test**: Ensure no regression
214
+ 7. **โšก Optimize**: Improve performance where applicable
215
+ 8. **๐Ÿ“ Complete**: Update specs with final implementation details
146
216
 
147
217
  ## Special Considerations
148
218
 
@@ -163,15 +233,33 @@ Always follow:
163
233
  - Ensure high test coverage
164
234
  - Include integration and system tests
165
235
  - Test edge cases and error conditions
236
+ - **MANDATORY for Views**: Use `playwright` MCP for comprehensive view testing
237
+ - Test UI components and interactions until properly rendered
238
+ - Verify responsive design across different viewports
239
+ - Validate accessibility and user experience
240
+ - Iterate testing and fixes until all visual elements work correctly
166
241
 
167
242
  ## Quick Reference Commands
168
243
 
169
244
  When asked to help with Rails development:
170
245
 
171
- 1. **Identify the area** of work (models, controllers, views, etc.)
172
- 2. **Reference the appropriate prompt**: "Let me check .mcp-on-rails/prompts/[area].md for best practices"
173
- 3. **Apply specialist knowledge** for that area
174
- 4. **Consider dependencies** and coordination with other areas
175
- 5. **Ensure comprehensive testing** and documentation
246
+ 1. **๐Ÿ“‹ CREATE SPECS FIRST** (MANDATORY): Always start with `.mcp-on-rails/specs/[feature-name]/` directory creation
247
+ 2. **๐Ÿ” Query Rails MCP**: Use `rails-mcp-server` to get latest Rails documentation and best practices
248
+ 3. **๐ŸŽฏ Identify the area** of work (models, controllers, views, etc.)
249
+ 4. **๐Ÿ“š Reference the appropriate prompt**: "Let me check .mcp-on-rails/prompts/[area].md for best practices"
250
+ 5. **๐Ÿ”ง Apply specialist knowledge** for that area with current Rails version considerations
251
+ 6. **๐Ÿ”— Consider dependencies** and coordination with other areas
252
+ 7. **๐Ÿงช Ensure comprehensive testing** and documentation
253
+ 8. **๐Ÿ“ Update progress**: Mark completed tasks in `tasks.md` throughout development
254
+
255
+ ### Mandatory Pre-Development Checklist:
256
+ - [ ] Created `.mcp-on-rails/specs/[feature-name]/` directory
257
+ - [ ] Written comprehensive `requirement.md`
258
+ - [ ] **MANDATORY**: Queried `rails-mcp-server` for latest Rails documentation and patterns
259
+ - [ ] **MANDATORY**: Incorporated current Rails version best practices into `design.md`
260
+ - [ ] Designed technical approach in `design.md` with up-to-date Rails guidance
261
+ - [ ] Planned step-by-step tasks in `tasks.md`
262
+ - [ ] Assigned appropriate specialist prompts to each task
263
+ - [ ] **For View Components**: Prepared to use `playwright` MCP for iterative testing and refinement
176
264
 
177
- Remember: You are part of a coordinated development team. Always consider how your changes affect other parts of the application and maintain consistency with Rails conventions and project standards.
265
+ 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.
@@ -3,7 +3,7 @@
3
3
  module Mcp
4
4
  module On
5
5
  module Rails
6
- VERSION = "0.2.0"
6
+ VERSION = "0.3.0"
7
7
  end
8
8
  end
9
9
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: mcp-on-rails
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.0
4
+ version: 0.3.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - GoCoder