Skip to content

Commit a5711f6

Browse files
committed
Update documentation to mention main deps
1 parent c41b7a7 commit a5711f6

File tree

2 files changed

+13
-8
lines changed

2 files changed

+13
-8
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,15 @@
22

33
Rails MCP Engine provides a unified tool-definition pipeline for Rails 8 applications. Service classes declare Sorbet-typed signatures and metadata once, and the engine auto-generates both RubyLLM and FastMCP tool classes at boot.
44

5+
## Core Dependencies
6+
7+
This engine is built on top of two powerful libraries:
8+
9+
- **[RubyLLM](https://github.com/crmne/ruby_llm)**: For generating LLM-compatible tool definitions.
10+
- **[FastMCP](https://github.com/yjacquin/fast-mcp)**: For creating Model Context Protocol (MCP) servers.
11+
- **[Sorbet](https://github.com/sorbet/sorbet)**: For static type checking and signature definitions.
12+
13+
514
## Installation
615

716
Add this line to your application's Gemfile:

rails_mcp_engine.gemspec

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,10 @@ Gem::Specification.new do |spec|
1616
spec.description = 'Unified tool definition pipeline for Rails 8 applications using FastMCP and RubyLLM.'
1717
spec.license = 'MIT'
1818

19-
# Prevent pushing this gem to RubyGems.org. To allow pushes, delete this section.
20-
if spec.respond_to?(:metadata)
21-
spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
22-
spec.metadata['rubygems_mfa_required'] = 'true'
23-
else
24-
raise 'RubyGems 2.0 or newer is required to protect against ' \
25-
'public gem pushes.'
26-
end
19+
spec.metadata['homepage_uri'] = spec.homepage
20+
spec.metadata['source_code_uri'] = spec.homepage
21+
spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/main/CHANGELOG.md"
22+
spec.metadata['rubygems_mfa_required'] = 'true'
2723

2824
spec.required_ruby_version = '>= 3.2.0'
2925

0 commit comments

Comments
 (0)