返回 MCP 目录
public公开dns本地运行

mcp-ruby

Model Context Protocol (MCP) 是一个开放标准,允许开发者在数据源和AI工具之间建立安全双向连接。该项目提供Ruby实现的gem包,包含完整的开发流程支持和类型检查功能。

article

README

🚀 模型上下文协议(MCP)

模型上下文协议(MCP)是一个开放标准,它能让开发人员构建安全的、双向的数据源与AI工具之间的连接,为数据与AI的交互提供了可靠的解决方案。

🚀 快速开始

目前此部分内容待定,后续可关注项目更新获取相关信息。

✨ 主要特性

目前此部分内容待定,后续可关注项目更新获取相关信息。

📦 安装指南

通过执行以下命令安装宝石:

$ gem install mcp-ruby

📚 详细文档

🔧 技术细节

开发流程

克隆仓库后,运行 bin/setup 安装依赖项。 要将宝石安装到本地机器上,请运行 bundle exec rake install。 您还可以运行 bin/console 以进入交互式提示符,该提示符允许您进行实验。 要发布新版本,请更新 version.rb 中的版本号,然后运行 bundle exec rake release,这将在 Git 中创建标签、提交更改和创建的标签,并将 .gem 文件推送到 rubygems.org

Rake任务

通过以下 Rake 任务确保代码库的健康和维护性,这些任务用于测试、Lint 和审计宝石中的安全漏洞和文档:

rake build                    # 将 mcp-ruby.gem 构建到 pkg 目录
rake build:checksum           # 如果将 mcp-ruby.gem 生成 SHA512 校验码到 checksums 目录
rake bundle:audit:check       # 检查 Gemfile.lock 中是否存在不安全的依赖项
rake bundle:audit:update      # 更新 bundler-audit 漏洞数据库
rake clean                    # 删除任何临时产品
rake clobber                  # 删除任何生成的文件
rake coverage                 # 使用覆盖运行测试
rake install                  # 构建并将 mcp-ruby.gem 安装到系统 gem 中
rake install:local            # 在没有网络访问的情况下构建并将 mcp-ruby.gem 安装到系统 gem 中
rake qa                       # 测试、Lint 并执行安全性和文档审核
rake release[remote]          # 创建一个标签,构建并推送到 rubygems.org
rake rubocop                  # 运行 RuboCop
rake rubocop:autocorrect      # 安全时自动修正 RuboCop 问题 (仅限安全)
rake rubocop:autocorrect_all  # 自动修正所有 RuboCop 问题(包括不安全的)
rake spec                     # 运行 RSpec 代码示例
rake verify_measurements      # 验证 yardstick 覆盖率是否至少为 100%
rake yard                     # 生成 YARD 文档
rake yard:which              # 显示 YARD 命令的完整路径
rake yardoc                  # 使用 YARD 重新生成文档

📄 许可证

该宝石作为开源软件以 MIT License 的条款提供。

👔 行为准则

所有与 MCP Ruby 项目代码库、问题跟踪器、聊天室和邮件列表互动的人都 expected 遵守 行为准则

help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端