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 にプッシュされます。

コードベースの健全性と保守性は、gem のテスト、lint、セキュリティ上の脆弱性およびドキュメントの監査を行う一連の Rake タスクによって確保されています。

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 では、Ruby プログラムの構造を記述する言語である RBS を活用しています。エディターでの型チェックと自動補完に使用されます。bundle exec typeprof FILENAME を実行すると、指定した Ruby ファイルの RBS 定義が生成されます。また、Steep を使って bundle exec steep check コマンドで定義をすべて検証できます。

🐞 問題とバグ

問題やバグを見つけた場合は、こちらから報告してください。確認のうえ、できるだけ早く修正します。

🤝 コントリビューション

GitHub（https://github.com/wilsonsilva/mcp-ruby）でのバグ報告やプルリクエストを歓迎します。 このプロジェクトは、誰もが安心して参加し、協力できる場を目指しています。コントリビューターには、行動規範を遵守していただきます。

📜 ライセンス

この gem は、MIT License の条件に基づくオープンソースとして利用できます。

👔 行動規範

MCP Ruby プロジェクトのコードベース、イシュートラッカー、チャットルーム、メーリングリストで活動するすべての人は、行動規範に従うことが求められます。