Mcproto

🚀 MCProto

MCProto is a Ruby framework that enables you to create customized solutions by connecting to MCP servers and leveraging Ruby code.

🚀 Quick Start

MCProto is a Ruby framework that allows you to implement customized solutions by linking to MCP servers and using auxiliary Ruby code.

📦 Installation

TODO: Release - This Gem is not publicly available yet.

💻 Usage Examples

Basic Usage

After installing the Gem, create an initialization file config/initializers/mcproto.rb and configure your server:

# Create any number of servers by passing the server class, host, and port.
beta_invite_server = MCProto::Server.new(
  InviteUserToBeta,
  host: 'localhost',
  port: 3000
)

# Execute any necessary logic before starting the server.
beta_invite_server.start!

Advanced Usage

For example, an MCP server can run independently:

# servers/tag_user.rb
class TriggerByEmail
  include MCProto 
  
  delegate :email, to: :context
  
  resource do
    # TODO
    # Define your resources (e.g., database tables)
    { name: 'email', description: 'Triggered by email' }
  end
  
  tool do
    # TODO
    description "Run when an email is mentioned."
  end
  
  call do
    Run unless email_exists?(email)
  end
  
  private
  
  def email_exists?(email)
    #...
  end
end

Or, chain them together:

# servers/invite_user_to_beta.rb
class InviteUserToBeta
  include MCProto::Chain
  
  chain [ TriggerByEmail, SendEmailInvite ]
end

Each server can access the context object and read data from previous servers or add its own data to the context.

📄 License

This Gem is provided as an open-source project and is released under the terms of the MIT License.

📚 Documentation

All individuals interacting in the Mcproto project's codebase, issue tracker, chat rooms, and mailing lists are expected to follow the code of conduct.