Mcpruby

🚀 VectorMCP English Guide

vector_mcp is a Ruby Gem used for creating and managing vector tools, resources, and prompts. It supports communication via standard input/output (Stdio) or Server-Sent Events (SSE) and offers a rich set of features, including tool registration, resource management, prompt templating, and support for custom handlers.

🚀 Quick Start

📦 Installation

Add Dependencies

Add the following dependency to your project:

gem 'vector_mcp'

Or clone the repository and install:

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

Install the Gem

To install the gem on your local machine, run:

bundle exec rake install

💻 Usage Examples

Basic Usage

Initialize the Server

Create and initialize a new VectorMCP::Server instance:

require 'vector_mcp'

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

Register a Tool

Tools are used to perform specific tasks. Register a simple calculator tool:

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

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

server.register_tool(:calculator, Calculator.new)

Register a Resource

Resources represent accessible files or data. Register an example resource:

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

Register a Prompt

Prompts are used to generate natural language output. Register a simple calculator prompt:

server.register_prompt(:calculator_prompt, 
  template: "Calculate the sum of %{a} and %{b}:",
  examples: [
    { input: [10, 20], output: "30" },
    { input: [5, 7], output: "12" }
  ])

Run the Server

Start the server to begin listening for requests:

server.start

Custom Handler (Middleware)

Add custom middleware to extend functionality:

server.use MyMiddleware.new

🔧 Technical Details

The core architecture of vector_mcp consists of the following main components:

• VectorMCP::Server: The main server class, responsible for initializing and managing all components.
• VectorMCP::ToolRegistry: The tool registry, used for storing and retrieving registered tools.
• VectorMCP::ResourceStore: The resource store, providing access to registered resources.
• VectorMCP::PromptTemplate: The prompt template, handling natural language generation tasks.

📚 Documentation

Run Tests

Run the test suite:

rspec spec/

Contribution Guidelines

To contribute to the project, please follow these steps:

1. Fork the repository to your own account.
2. Create a new feature branch.
3. Commit your changes and create a pull request.

Issue Reporting

If you encounter any issues or have suggestions for improvement, please report them on the GitHub Issues page.

📄 License

vector_mcp is released under the MIT License. Please refer to the LICENSE file for detailed information.