Mcpruby

🚀 VectorMCP 日本語ガイド

vector_mcp は、ベクトル（Vector）のツール、リソース、およびプロンプト（Prompt）を作成および管理するための Ruby Gem です。標準入出力（Stdio）または Server-Sent Events (SSE) を通じた通信をサポートし、ツール登録、リソース管理、プロンプトのテンプレート化、およびカスタムハンドラのサポートなど、豊富な機能を提供します。

🚀 クイックスタート

vector_mcp を使用することで、ベクトル関連のツールやリソースを簡単に管理できます。また、独自の処理を追加することも可能です。

📦 インストール

依存関係の追加

プロジェクトに以下の依存関係を追加します：

gem 'vector_mcp'

または、リポジトリをクローンしてインストールします：

git clone https://github.com/sergiobayona/vector_mcp.git
cd vector_mcp
bundle install

Gem のインストール

gem をローカルコンピュータにインストールするには、以下のコマンドを実行します：

bundle exec rake install

💻 使用例

基本的な使用法

サーバーの初期化

新しい VectorMCP::Server インスタンスを作成して初期化します：

require 'vector_mcp'

server = VectorMCP::Server.new(
  logger: Logger.new(STDOUT),
  session_store: VectorMCP::MemoryStore.new
)

ツール（Tool）の登録

特定のタスクを実行するためのツールを登録します。簡単な電卓ツールを登録します：

class Calculator
  def add(a, b)
    a + b
  end

  def subtract(a, b)
    a - b
  end
end

server.register_tool(:calculator, Calculator.new)

リソース（Resource）の登録

アクセス可能なファイルやデータを表すリソースを登録します。サンプルリソースを登録します：

server.register_resource(:example_resource) do |params|
  "Example resource content"
end

プロンプト（Prompt）の登録

自然言語出力を生成するためのプロンプトを登録します。簡単な電卓プロンプトを登録します：

server.register_prompt(:calculator_prompt, 
  template: "计算 %{a} 和 %{b} 的和：",
  examples: [
    { input: [10, 20], output: "30" },
    { input: [5, 7], output: "12" }
  ])

サーバーの起動

リクエストの監視を開始するためにサーバーを起動します：

server.start

カスタムハンドラ（Middleware）の追加

機能を拡張するためにカスタムミドルウェアを追加します：

server.use MyMiddleware.new

📚 ドキュメント

アーキテクチャ

vector_mcp の核心アーキテクチャは、以下の主要な部分で構成されています：

• VectorMCP::Server：すべてのコンポーネントの初期化と管理を担当するサーバーのメインクラス。
• VectorMCP::ToolRegistry：登録されたツールを格納および検索するためのツールレジストリ。
• VectorMCP::ResourceStore：登録されたリソースへのアクセスを提供するリソースストア。
• VectorMCP::PromptTemplate：自然言語生成タスクを処理するプロンプトテンプレート。

開発

テストの実行

テストスイートを実行します：

rspec spec/

貢献ガイド

プロジェクトに貢献するには、以下の手順に従ってください：

1. リポジトリを自分のアカウントにフォークします。
2. 新しい機能ブランチを作成します。
3. 変更をコミットし、プルリクエストを作成します。

問題報告

問題が発生した場合や改善提案がある場合は、GitHub Issues ページで報告してください。

📄 ライセンス

vector_mcp は MIT ライセンスの下で公開されています。詳細については LICENSE ファイルを参照してください。