foobara-mcp-connector 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e4048b44adee3a3ab2d8ed0092495c6cb017901be71c96bfb328aa5fbaaed29
-  data.tar.gz: 244c334f637a11a5f78f41cb1bc26c228cf315237b8755d076bbdd3ef7653e48
+  metadata.gz: e2612f7963226cafc0400e04148da936a7e9ce1917807af4f4cb23eefb8016df
+  data.tar.gz: 6343d09c7a92e7539a02d03ed04cb660cabb4bca2a0850e7264dfbf6ea07c43a
 SHA512:
-  metadata.gz: 213609332b4d1a02d950f6e046eb57f4d41cf91b1102a57c200dd159684e8fda53b936cfb8bf8e7bbcdd831a55db832bad3e63816ed04ccedf229319349f9110
-  data.tar.gz: 84c7bcde7c0d0696685f886f289cecddf680bb89383c1954fa1605e4bef225b19fd85fc3c2401f3e9af4a1e37ce2154b533a8f7314f793753326865071d687b4
+  metadata.gz: b10bdb8f993722f1096d2237c20303444c6518c2aaaec22995511846a61026a36762e2e330e402f5b3d1e1a5ad11c308de0e98d426df2028ff6f17adda6683f6
+  data.tar.gz: e244dfacd2e96c300fb7cebb9557f9ce3b3191624f0bf1c3eb232a0fcbbfc7ce0c649ce252427e5ade4068a4601f88bc27d3aecf3ac879a4acba73d3e7102a64

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [0.0.2] - 2025-04-12
+
+- Add more examples
+- Update README.md with new examples
+- Add description to gem
+
 ## [0.0.1] - 2025-04-11
 
 - Initial release

data/README.md

@@ -1,6 +1,18 @@
 # Foobara::McpConnector
 
-Exposes Foobara commands according to the Model Context Protocol specification
+Exposes Foobara commands according to the Model Context Protocol (MCP) specification
+
+<!-- TOC -->
+* [Foobara::McpConnector](#foobaramcpconnector)
+  * [Installation](#installation)
+  * [Usage](#usage)
+    * [Super basic example](#super-basic-example)
+    * [An example with entities](#an-example-with-entities)
+    * [A destructive example](#a-destructive-example)
+    * [Moar examples](#moar-examples)
+  * [Contributing](#contributing)
+  * [License](#license)
+<!-- TOC -->
 
 ## Installation
 
@@ -11,6 +23,8 @@ Typical stuff: add `gem "foobara-mcp-connector` to your Gemfile or .gemspec file
 
 You can find examples in `examples/`
 
+### Super basic example
+
 Let's create a simple Foobara command:
 
 ```ruby
@@ -96,18 +110,133 @@ $ claude
 ● 125
 > Thanks!
 ● You're welcome!
-╭───────────────────────────────────────────────────────────────────────╮
-│ >                                                                     │
-╰───────────────────────────────────────────────────────────────────────╯
 ```
 
-Please see the examples/ directory for more examples
+### An example with entities
+
+Let's say we have a model (see examples/capybaras.rb):
+
+```ruby
+class Capybara < Foobara::Entity
+  attributes do
+    id :integer
+    name :string, :required
+    year_of_birth :integer, :required
+  end
+
+  primary_key :id
+end
+```
+
+As well as some commands like `FindAllCapybaras`, `CreateCapybara`, and `UpdateCapybara`
+(see examples/capybara_commands.rb)
+
+We can write an MCP connector to expose those commands so we can ask questions that require
+running those commands to answer:
+
+```ruby
+require "foobara/mcp_connector"
+require_relative "capybara_commands"
+
+CreateCapybara.run!(name: "Fumiko", year_of_birth: 2020)
+CreateCapybara.run!(name: "Barbara", year_of_birth: 2019)
+CreateCapybara.run!(name: "Basil", year_of_birth: 2021)
+
+mcp_connector = Foobara::McpConnector.new
+mcp_connector.connect(FindAllCapybaras)
+
+mcp_connector.run_stdio_server
+```
+
+We can now ask a tool like claude a relevant question:
+
+```
+$ claude
+> Which Capybara is the oldest?
+● mcp-test:FindAllCapybaras (MCP)()…
+  ⎿  [
+       {
+         "name": "Fumiko",
+         "year_of_birth": 2020,
+         "id": 1
+
+     … +7 lines (ctrl+r to expand)
+
+         "name": "Basil",
+         "year_of_birth": 2021,
+         "id": 3
+       }
+     ]
+
+● Barbara (born in 2019)
+> Thanks!
+● You're welcome!
+```
+
+### A destructive example
+
+Let's say we would like to mutate data. Let's pretend we've accidentally entered a year-of-birth
+in a 2-digit format where a 4-digit format was expected. Let's do that and also expose our UpdateCapybara
+command:
+
+```ruby
+# We will simulate a year accidentally being entered with a 2-digit format where a 4-digit format was expected
+UpdateCapybara.run!(id: barbara.id, year_of_birth: 19)
+
+mcp_connector = Foobara::McpConnector.new
+
+mcp_connector.connect(FindAllCapybaras)
+mcp_connector.connect(UpdateCapybara)
+
+mcp_connector.run_stdio_server
+```
+
+Now we can ask a tool like claude to find and fix our data:
+
+```
+$ claude
+> Hi! There's a Capybara whose birth year was entered incorrectly. Can you find which one
+  and fix it? Thanks!
+● I'll help find and fix the capybara with the incorrect birth year. Let me search for the
+  capybaras first.
+● mcp-test:FindAllCapybaras (MCP)()…
+  ⎿  [
+       {
+         "name": "Fumiko",
+         "year_of_birth": 2020,
+         "id": 1
+
+     … +7 lines (ctrl+r to expand)
+
+         "name": "Basil",
+         "year_of_birth": 2021,
+         "id": 3
+       }
+     ]
+● It looks like Barbara (id 2) has an incorrect birth year of 19, which is too low. Let me
+  fix that to 2019.
+● mcp-test:UpdateCapybara (MCP)(id: 2, year_of_birth: 2019)…
+  ⎿  {
+       "name": "Barbara",
+       "year_of_birth": 2019,
+       "id": 2
+     }
+● Fixed! Barbara's birth year has been updated from 19 to 2019.
+> Great! Thanks!
+● You're welcome!
+```
+
+### Moar examples
+
+Please see the examples/ directory for executable scripts of these examples.
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub
 at https://github.com/foobara/mcp-connector
 
+Feel free to reach out if you'd like help with this gem or if you'd like to help with this gem!
+
 ## License
 
 This project is licensed under the MPL-2.0 license. Please see LICENSE.txt for more info.

data/version.rb

@@ -1,6 +1,6 @@
 module Foobara
   module McpConnectorVersion
-    VERSION = "0.0.1".freeze
+    VERSION = "0.0.2".freeze
 
     local_ruby_version = File.read("#{__dir__}/.ruby-version").chomp
     local_ruby_version_minor = local_ruby_version[/\A(\d+\.\d+)\.\d+\z/, 1]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foobara-mcp-connector
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Miles Georgi
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.97
+        version: 0.0.101
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.97
+        version: 0.0.101
 - !ruby/object:Gem::Dependency
   name: foobara-json-schema-generator
   requirement: !ruby/object:Gem::Requirement
@@ -81,5 +81,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.7
 specification_version: 4
-summary: No description. Add one.
+summary: Gives an easy way to expose your Foobara commands to tools like Claude Code
+  via the Model Context Protocol (MCP)
 test_files: []