🚀 MCProto 使用说明

MCProto 是一个 Ruby 框架，借助它，你能够连接 MCP 服务器，并配合 Ruby 代码实现定制化解决方案。

🚀 快速开始

MCProto 是一个 Ruby 框架，允许你通过链接 MCP 服务器和辅助 Ruby 代码来实现定制化解决方案。

📦 安装指南

TODO: 发布 - 该 Gems 目前尚未公开发布

💻 使用示例

基础用法

安装 Gems 后，创建一个初始化文件 config/initializers/mcproto.rb 并配置你的服务器：

# 创建任意数量的服务器，只需传递服务器类、主机和端口即可。
beta_invite_server = MCProto::Server.new(
  InviteUserToBeta,
  host: 'localhost',
  port: 3000
)

# 在启动服务器之前执行任何需要的逻辑。
beta_invite_server.start!

高级用法

独立运行 MCP 服务器

例如，一个 MCP 服务器可以独立运行：

# servers/tag_user.rb
class TriggerByEmail
  include MCProto 
  
  delegate :email, to: :context
  
  resource do
    # TODO
    # 定义你的资源（例如数据库表）
    { name: 'email', description: '通过电子邮件触发' }
  end
  
  tool do
    # TODO
    description "当提及到电子邮件时运行。"
  end
  
  call do
    运行 除非电子邮件已存在?(email)
  end
  
  private
  
  def email_exists?(email)
    #...
  end
end

链式连接服务器

或者，将它们链式连接在一起：

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

每个服务器都可以访问 context 对象，并从之前的服务器读取数据，或向上下文添加自己的数据。

📄 许可证

该 Gems 作为开源项目提供，使用 MIT 许可证的条款发布。

📚 详细文档

所有在 Mcproto 项目的代码库、问题跟踪器、聊天室和邮件列表中互动的人都 expected to follow the code of conduct。