VectorMCP 中文指南

简介

vector_mcp 是一个用于创建和管理向量（Vector）工具、资源和提示（Prompt）的 Ruby Gem。它支持通过标准输入输出（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 文件获取详细信息。