MCP Ruby

🚀 Model Context Protocol (MCP)

The Model Context Protocol is an open standard that enables developers to build secure, two-way connections between data sources and AI tools.

Table of Contents

• ✨ Features
• 📦 Installation
• 🚀 Quick Start
• 📚 Documentation
• 🔨 Development
  • Type Checking
• 🤝 Contribution
• 📄 License
• 👔 Code of Conduct

✨ Features

To be determined.

📦 Installation

Install the gem by executing the following command:

$ gem install mcp-ruby

🚀 Quick Start

To be determined.

📚 Documentation

• YARD Documentation

🔨 Development

After cloning the repository, run bin/setup to install the dependencies.

To install the gem on your local machine, run bundle exec rake install.

You can also run bin/console to enter an interactive prompt that allows you to experiment.

To release a new version, update the version number in version.rb, then run bundle exec rake release, which will create a tag in Git, commit the changes and the created tag, and push the .gem file to rubygems.org.

Ensure the health and maintainability of the codebase through the following Rake tasks, which are used to test, lint, and audit security vulnerabilities and documentation in the gem:

rake build                    # Build mcp-ruby.gem into the pkg directory
rake build:checksum           # Generate a SHA512 checksum for mcp-ruby.gem into the checksums directory if it exists
rake bundle:audit:check       # Check for insecure dependencies in Gemfile.lock
rake bundle:audit:update      # Update the bundler-audit vulnerability database
rake clean                    # Remove any temporary products
rake clobber                  # Remove any generated files
rake coverage                 # Run tests with coverage
rake install                  # Build and install mcp-ruby.gem into the system gems
rake install:local            # Build and install mcp-ruby.gem into the system gems without network access
rake qa                       # Test, lint, and perform security and documentation audits
rake release[remote]          # Create a tag, build, and push to rubygems.org
rake rubocop                  # Run RuboCop
rake rubocop:autocorrect      # Automatically correct RuboCop issues when safe (safe only)
rake rubocop:autocorrect_all  # Automatically correct all RuboCop issues (including unsafe ones)
rake spec                     # Run RSpec code examples
rake verify_measurements      # Verify that yardstick coverage is at least 100%
rake yard                     # Generate YARD documentation
rake yard:which              # Display the full path to the YARD command
rake yardoc                  # Regenerate documentation with YARD

📄 License

This gem is provided as open-source software under the terms of the MIT License.

👔 Code of Conduct

All those interacting with the MCP Ruby project's codebase, issue tracker, chat rooms, and mailing lists are expected to follow the Code of Conduct.