Model Context Protocol (MCP)

Model Context Protocol (MCP)

Model Context Protocol 是一项开放标准，支持开发者在数据源与 AI 驱动的工具之间建立安全的双向连接。

目录

• 主要功能
• 安装
• 快速入门
• 文档
• 开发
  • 类型检查
• 贡献
• 许可证
• 行为准则

🔑 主要功能

TODO

📦 安装

执行以下命令安装 gem：

$ gem install mcp-ruby

⚡️ 快速入门

TODO

📚 文档

• YARD 文档

🔨 开发

检出仓库后，运行 bin/setup 安装依赖项。

要将此 gem 安装到本地计算机，请运行 bundle exec rake install。

你也可以运行 bin/console，使用交互式提示词进行试用。

要发布新版本，请更新 version.rb 中的版本号，然后运行 bundle exec rake release。该命令会为此版本创建 git 标签，推送 git 提交和创建的标签，并将 .gem 文件推送到 rubygems.org。

我们通过一组 Rake 任务来测试、检查代码风格并审计 gem 的安全漏洞和文档，以确保代码库的健康状况和可维护性：

rake build                    # Build mcp-ruby.gem into the pkg directory
rake build:checksum           # Generate SHA512 checksum if mcp-ruby.gem into the checksums directory
rake bundle:audit:check       # Checks the Gemfile.lock for insecure dependencies
rake bundle:audit:update      # Updates the bundler-audit vulnerability database
rake clean                    # Remove any temporary products
rake clobber                  # Remove any generated files
rake coverage                 # Run spec with coverage
rake install                  # Build and install mcp-ruby.gem into system gems
rake install:local            # Build and install mcp-ruby.gem into system gems without network access
rake qa                       # Test, lint and perform security and documentation audits
rake release[remote]          # Create a tag, build and push mcp-ruby.gem to rubygems.org
rake rubocop                  # Run RuboCop
rake rubocop:autocorrect      # Autocorrect RuboCop offenses (only when it's safe)
rake rubocop:autocorrect_all  # Autocorrect RuboCop offenses (safe and unsafe)
rake spec                     # Run RSpec code examples
rake verify_measurements      # Verify that yardstick coverage is at least 100%
rake yard                     # Generate YARD Documentation
rake yard:junk                # Check the junk in your YARD Documentation
rake yardstick_measure        # Measure docs in lib/**/*.rb with yardstick

类型检查

此 gem 使用 RBS，这是一种用于描述 Ruby 程序结构的语言，可在编辑器中提供类型检查和自动补全。运行 bundle exec typeprof FILENAME 为指定的 Ruby 文件生成 RBS 定义。然后使用 Steep 运行命令 bundle exec steep check，验证所有定义。

🐞 问题与错误

如果发现任何问题或错误，请在此处报告。我很乐意查看并尽快修复。

🤝 贡献

欢迎在 GitHub 上提交错误报告和拉取请求：https://github.com/wilsonsilva/mcp-ruby。 本项目致力于营造安全、友好的协作环境，贡献者应遵守行为准则。

📜 许可证

此 gem 根据 MIT License 的条款以开源形式提供。

👔 行为准则

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