Skip to content

Commit a74f422

Browse files
committed
update README and cursor rule
1 parent b27015b commit a74f422

File tree

2 files changed

+33
-15
lines changed

2 files changed

+33
-15
lines changed
Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,30 @@
11
---
22
description: writing changelog markdown when cutting a new release of the gem
3-
globs:
3+
globs:
44
alwaysApply: false
55
---
6-
- output the changelog as markdown when asked.
6+
- output the changelog as markdown when asked.
77
- git tags are used to mark the commit that cut a new release of the gem
8-
- the gem version is located in [version.rb](mdc:lib/model_context_protocol/version.rb)
8+
- the gem version is located in [version.rb](mdc:lib/mcp/version.rb)
99
- use the git history, especially merge commits from PRs to construct the changelog
10-
- when necessary, look at the diff of files changed to determine whether a PR should be listed in
10+
- when necessary, look at the diff of files changed to determine whether a PR should be listed in
1111
- ## Added; adds new functionality
1212
- ## Changed; alters functionality; especially backward compatible changes
13-
- ## Fixed; bugfixes that are forward compatible
13+
- ## Fixed; bugfixes that are forward compatible
1414

1515
use the following format for changelogs:
1616

17-
https://cloudsmith.io/~shopify/repos/gems/packages/detail/ruby/mcp-ruby/{gem version}/
18-
19-
# Changelog
20-
17+
```
2118
## Added
2219
- New functionality added that was not present before
2320

2421
## Changed
2522
- Alterations to functionality that may indicate breaking changes
2623

2724
## Fixed
28-
- Bug fixes
25+
- Bug fixes
2926

3027
#### Full change list:
31-
- [Name of the PR #123](mdc:https:/github.com/Shopify/mcp-ruby/pull/123) @github-author-username
32-
- [Name of the PR #456](mdc:https:/github.com/Shopify/mcp-ruby/pull/456) @another-github-author
28+
- [Name of the PR #123](https:/github.com/modelcontextprotocol/ruby-sdk/pull/123) @github-author-username
29+
- [Name of the PR #456](https:/github.com/modelcontextprotocol/ruby-sdk/pull/456) @another-github-author
30+
```

README.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,29 @@
22

33
A Ruby gem for implementing Model Context Protocol servers
44

5+
## Installation
6+
7+
Add this line to your application's Gemfile:
8+
9+
```ruby
10+
gem 'mcp'
11+
```
12+
13+
And then execute:
14+
15+
```bash
16+
$ bundle install
17+
```
18+
19+
Or install it yourself as:
20+
21+
```bash
22+
$ gem install mcp
23+
```
24+
525
## MCP Server
626

7-
The `ModelContextProtocol::Server` class is the core component that handles JSON-RPC requests and responses.
27+
The `MCP::Server` class is the core component that handles JSON-RPC requests and responses.
828
It implements the Model Context Protocol specification, handling model context requests and responses.
929

1030
### Key Features
@@ -67,8 +87,8 @@ If you want to build a local command-line application, you can use the stdio tra
6787

6888
```ruby
6989
#!/usr/bin/env ruby
70-
require "model_context_protocol"
71-
require "model_context_protocol/transports/stdio"
90+
require "mcp"
91+
require "mcp/transports/stdio"
7292

7393
# Create a simple tool
7494
class ExampleTool < ModelContextProtocol::Tool

0 commit comments

Comments
 (0)