Mcpruby

🚀 VectorMCP 中文指南

vector_mcp 是一款強大的 Ruby Gem，專注於向量（Vector）工具、資源和提示（Prompt）的創建與管理。它支持通過標準輸入輸出（Stdio）或 Server-Sent Events (SSE) 進行通信，具備工具註冊、資源管理、提示模板化等豐富功能，為開發者提供了便捷的開發體驗。

🚀 快速開始

vector_mcp 是一個用於創建和管理向量（Vector）工具、資源和提示（Prompt）的 Ruby Gem。它支持通過標準輸入輸出（Stdio）或 Server-Sent Events (SSE) 進行通信，並提供了豐富的功能，包括工具註冊、資源管理、提示模板化以及自定義處理程序的支持。

✨ 主要特性

• 通信方式多樣：支持通過標準輸入輸出（Stdio）或 Server-Sent Events (SSE) 進行通信。
• 功能豐富：提供工具註冊、資源管理、提示模板化以及自定義處理程序的支持。

📦 安裝指南

添加依賴

在項目中添加以下依賴：

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 文件獲取詳細信息。