Skip to content

Commit a4df3b8

Browse files
committed
Internal Release v0.1.1
- implement `Prompt` - adjust Tool approach - update readme for tool calling - document usage of `Prompt`
0 parents  commit a4df3b8

34 files changed

+1530
-0
lines changed

.gitattributes

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# See https://git-scm.com/docs/gitattributes for more about git attribute files.
2+
3+
# Mark any vendored files as having been vendored.
4+
vendor/* linguist-vendored

.github/workflows/ci.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: CI
2+
on: [push, pull_request]
3+
4+
jobs:
5+
test:
6+
runs-on: ubuntu-latest
7+
strategy:
8+
matrix:
9+
entry:
10+
- { ruby: 3.2, allowed-failure: false }
11+
- { ruby: 3.3, allowed-failure: false }
12+
- { ruby: 3.4, allowed-failure: false }
13+
- { ruby: head, allowed-failure: true }
14+
name: Test Ruby ${{ matrix.entry.ruby }}
15+
steps:
16+
- uses: actions/checkout@v3
17+
- uses: ruby/setup-ruby@v1
18+
with:
19+
ruby-version: ${{ matrix.entry.ruby }}
20+
bundler-cache: true
21+
- run: bundle exec rake test
22+
continue-on-error: ${{ matrix.entry.allowed-failure }}

.gitignore

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
/.bundle/
2+
/.yardoc
3+
/_yardoc/
4+
/coverage/
5+
/doc/
6+
/pkg/
7+
/spec/reports/
8+
/tmp/

.rubocop.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
inherit_gem:
2+
rubocop-shopify: rubocop.yml

.ruby-version

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
3.3.0

CODE_OF_CONDUCT.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [email protected]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at [http://contributor-covenant.org/version/1/4][version]
72+
73+
[homepage]: http://contributor-covenant.org
74+
[version]: http://contributor-covenant.org/version/1/4/

Gemfile

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# frozen_string_literal: true
2+
3+
source "https://rubygems.org"
4+
5+
# Specify runtime dependencies in the gemspec
6+
gemspec
7+
8+
# Specify development dependencies below
9+
gem "minitest", "~> 5.1", require: false
10+
gem "rake", "~> 13.0"
11+
gem "rubocop-shopify", require: false
12+
13+
gem "activesupport"
14+
gem "minitest-reporters"
15+
gem "mocha"

Gemfile.lock

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
PATH
2+
remote: .
3+
specs:
4+
model_context_protocol (0.1.1)
5+
activesupport
6+
7+
GEM
8+
remote: https://rubygems.org/
9+
specs:
10+
activesupport (8.0.2)
11+
base64
12+
benchmark (>= 0.3)
13+
bigdecimal
14+
concurrent-ruby (~> 1.0, >= 1.3.1)
15+
connection_pool (>= 2.2.5)
16+
drb
17+
i18n (>= 1.6, < 2)
18+
logger (>= 1.4.2)
19+
minitest (>= 5.1)
20+
securerandom (>= 0.3)
21+
tzinfo (~> 2.0, >= 2.0.5)
22+
uri (>= 0.13.1)
23+
ansi (1.5.0)
24+
ast (2.4.3)
25+
base64 (0.2.0)
26+
benchmark (0.4.0)
27+
bigdecimal (3.1.9)
28+
builder (3.3.0)
29+
concurrent-ruby (1.3.5)
30+
connection_pool (2.5.3)
31+
drb (2.2.1)
32+
i18n (1.14.7)
33+
concurrent-ruby (~> 1.0)
34+
json (2.11.3)
35+
language_server-protocol (3.17.0.4)
36+
lint_roller (1.1.0)
37+
logger (1.7.0)
38+
minitest (5.25.5)
39+
minitest-reporters (1.7.1)
40+
ansi
41+
builder
42+
minitest (>= 5.0)
43+
ruby-progressbar
44+
mocha (2.7.1)
45+
ruby2_keywords (>= 0.0.5)
46+
parallel (1.27.0)
47+
parser (3.3.8.0)
48+
ast (~> 2.4.1)
49+
racc
50+
prism (1.4.0)
51+
racc (1.8.1)
52+
rainbow (3.1.1)
53+
rake (13.2.1)
54+
regexp_parser (2.10.0)
55+
rubocop (1.75.5)
56+
json (~> 2.3)
57+
language_server-protocol (~> 3.17.0.2)
58+
lint_roller (~> 1.1.0)
59+
parallel (~> 1.10)
60+
parser (>= 3.3.0.2)
61+
rainbow (>= 2.2.2, < 4.0)
62+
regexp_parser (>= 2.9.3, < 3.0)
63+
rubocop-ast (>= 1.44.0, < 2.0)
64+
ruby-progressbar (~> 1.7)
65+
unicode-display_width (>= 2.4.0, < 4.0)
66+
rubocop-ast (1.44.1)
67+
parser (>= 3.3.7.2)
68+
prism (~> 1.4)
69+
rubocop-shopify (2.17.0)
70+
rubocop (~> 1.62)
71+
ruby-progressbar (1.13.0)
72+
ruby2_keywords (0.0.5)
73+
securerandom (0.4.1)
74+
tzinfo (2.0.6)
75+
concurrent-ruby (~> 1.0)
76+
unicode-display_width (3.1.4)
77+
unicode-emoji (~> 4.0, >= 4.0.4)
78+
unicode-emoji (4.0.4)
79+
uri (1.0.3)
80+
81+
PLATFORMS
82+
arm64-darwin-23
83+
ruby
84+
85+
DEPENDENCIES
86+
activesupport
87+
minitest (~> 5.1)
88+
minitest-reporters
89+
mocha
90+
model_context_protocol!
91+
rake (~> 13.0)
92+
rubocop-shopify
93+
94+
BUNDLED WITH
95+
2.5.9

LICENSE.txt

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2025 TODO: Write your name
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.

README.md

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
# Model Context Protocol
2+
3+
A Ruby gem implementing Model Context Protocol + JSON RPC 2.0 spec
4+
5+
## Overview
6+
7+
Model Context Protocol provides a standardized way to interact with language models through a JSON RPC 2.0 interface.
8+
9+
It handles request/response formatting, error handling, and tool integrations in a type-safe manner using Sorbet.
10+
11+
See https://spec.modelcontextprotocol.io/specification/
12+
13+
This implementation breaks from the transport examples in the spec as it implements a POST-based JSON RPC call rather
14+
than a stateful SSE transport.
15+
16+
## MCP Server
17+
18+
The `ModelContextProtocol::Server` class is the core component that handles JSON-RPC requests and responses.
19+
It implements the Model Context Protocol specification, handling model context requests and responses.
20+
21+
### Key Features
22+
23+
- Implements JSON-RPC 2.0 message handling
24+
- Supports protocol initialization and capability negotiation
25+
- Manages tool registration and invocation
26+
- Provides type-safe request/response handling using Sorbet
27+
28+
### Supported Methods
29+
30+
- `initialize` - Initializes the protocol and returns server capabilities
31+
- `ping` - Simple health check that returns "pong"
32+
- `tools/list` - Lists all registered tools and their schemas
33+
- `tools/call` - Invokes a specific tool with provided arguments
34+
- `prompts/list` - Lists all registered prompts and their schemas
35+
- `prompts/get` - Retrieves a specific prompt by name
36+
37+
### Usage
38+
39+
Implement an `ApplicationController` which calls the `Server#handle` method, eg
40+
41+
```ruby
42+
module ModelContextProtocol
43+
class ApplicationController < ActionController::Base
44+
45+
sig { void }
46+
def index
47+
server = ModelContextProtocol::Server.new(
48+
name: "my_server",
49+
tools: [someTool, anotherTool],
50+
prompts: [myPrompt]
51+
)
52+
render(json: server.handle(request.body.read).to_h)
53+
end
54+
end
55+
end
56+
```
57+
58+
## Tools
59+
60+
MCP spec includes [Tools](https://modelcontextprotocol.io/docs/concepts/tools) which provide functionality to LLM apps.
61+
62+
This gem provides a `ModelContextProtocol::Tool` class that can be instantiated to create tools.
63+
64+
Tools can be passed into the `ModelContextProtocol::Server` constructor to register them with the server.
65+
66+
### Example Tool Implementation
67+
68+
The `Tool` class allows creating tools that can be used within the model context.
69+
To create a tool, instantiate the class with the required parameters and an optional block:
70+
71+
```ruby
72+
tool = ModelContextProtocol::Tool.new(name: "my_tool", description: "This tool performs specific functionality...") do |args|
73+
# Implement the tool's functionality here
74+
result = process_something(args["parameter_name"])
75+
ModelContextProtocol::Tool::Response.new([{ type: "text", text: result }], false )
76+
end
77+
```
78+
79+
## Prompts
80+
81+
MCP spec includes
82+
[Prompts](https://modelcontextprotocol.io/docs/concepts/prompts), `Prompts` enable servers to define reusable prompt
83+
templates and workflows that clients can easily surface to users and LLMs
84+
85+
The `Prompt` class allows creating prompts that can be used within the model context.
86+
87+
To create a prompt, instantiate the class with the required parameters and an optional block:
88+
89+
```ruby
90+
prompt = ModelContextProtocol::Prompt.new(name: "my_prompt", description: "This prompt performs specific functionality...") do |args|
91+
# Implement the prompt's functionality here
92+
result = template_something(args["parameter_name"])
93+
ModelContextProtocol::Prompt::Response.new([{ type: "text", text: result }], false )
94+
end
95+
```
96+
97+
98+
99+
100+
## Releases
101+
102+
TODO

0 commit comments

Comments
 (0)