Skip to content

Rails MCP Server: Enhanced Documentation Access

Choose a tag to compare

@mariochavez mariochavez released this 03 Jun 17:04
· 37 commits to main since this release
29178a4

Added

  • Comprehensive Resources and Documentation System: Complete access to Rails ecosystem documentation
    • load_guide tool for accessing official framework documentation
    • Support for Rails, Turbo, Stimulus, and Kamal documentation
    • Custom markdown file import capabilities
    • Automatic resource downloading via rails-mcp-server-download-resources command
    • Resource storage in XDG-compliant directories with manifest tracking
  • Five Resource Categories:
    • Rails Guides: Official Ruby on Rails 8.0.2 documentation (50+ guides)
    • Turbo Guides: Complete Hotwire Turbo framework documentation
    • Stimulus Guides: Full Stimulus JavaScript framework documentation
    • Kamal Guides: Comprehensive Kamal deployment tool documentation
    • Custom Guides: Import and manage your own markdown documentation
  • Direct Resource Access: MCP clients can query resources using URI templates
    • rails://guides/{guide_name} for Rails documentation
    • turbo://guides/{guide_name} for Turbo guides
    • stimulus://guides/{guide_name} for Stimulus documentation
    • kamal://guides/{guide_name} for Kamal guides
    • custom://guides/{guide_name} for custom imports
  • Advanced Resource Management:
    • Force download options (--force) for updating resources
    • Verbose logging (--verbose) for troubleshooting
    • Batch import support for directory structures
    • Filename normalization for custom imports
    • Version tracking and update management

Improved

  • Enhanced Documentation: All tools now include comprehensive natural language examples
  • Resource Integration: Seamless integration with existing MCP tool ecosystem
  • File Organization: Better project structure with XDG Base Directory compliance
  • Error Handling: Improved validation and error messages across resource operations

Technical

  • URI templating support for direct resource access
  • Enhanced manifest management for resource tracking
  • Integration with FastMCP for robust resource handling
  • Simplified guides configuration and management