Skip to content

Commit ea49dc2

Browse files
committed
added logo and some badges
1 parent 82c5793 commit ea49dc2

4 files changed

Lines changed: 27 additions & 6 deletions

File tree

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
11
<img src="/docs/assets/images/logotype.svg" alt="RubyLLM" height="120" width="250">
22

3-
**Aiming to make using MCPs with RubyLLM and Ruby as easy as possible.**
4-
5-
This project is a Ruby client for the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/), designed to work seamlessly with [RubyLLM](https://github.com/crmne/ruby_llm). This gem enables Ruby applications to connect to MCP servers and use their tools, resources and prompts as part of LLM conversations.
6-
7-
For a more detailed guide, see the RubyLLM::MCP [docs](https://rubyllm-mcp.com/).
83

94
<div class="badge-container">
105
<a href="https://badge.fury.io/rb/ruby_llm-mcp"><img src="https://badge.fury.io/rb/ruby_llm-mcp.svg" alt="Gem Version" /></a>
116
<a href="https://rubygems.org/gems/ruby_llm-mcp"><img alt="Gem Downloads" src="https://img.shields.io/gem/dt/ruby_llm-mcp"></a>
127
</div>
138

14-
## RubyLLM::MCPFeatures
9+
**Aiming to make using MCPs with RubyLLM and Ruby as easy as possible.**
10+
11+
This project is a Ruby client for the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/), designed to work seamlessly with [RubyLLM](https://github.com/crmne/ruby_llm). This gem enables Ruby applications to connect to MCP servers and use their tools, resources and prompts as part of LLM conversations.
12+
13+
For a more detailed guide, see the RubyLLM::MCP [docs](https://rubyllm-mcp.com/).
14+
15+
## RubyLLM::MCP Features
1516

1617
- 🔌 **Multiple Transport Types**: Streamable HTTP, and STDIO and legacy SSE transports
1718
- 🛠️ **Tool Integration**: Automatically converts MCP tools into RubyLLM-compatible tools

docs/_sass/custom/custom.scss

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,11 @@
44
flex-wrap: wrap;
55
gap: 1em;
66
}
7+
8+
.badge-container {
9+
display: flex;
10+
align-items: center;
11+
flex-wrap: wrap;
12+
gap: 0.5em;
13+
margin: 1em 0;
14+
}

docs/configuration.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,13 @@ RubyLLM::MCP.configure do |config|
3434
# Or use a custom logger
3535
config.logger = Logger.new(STDOUT)
3636

37+
# Paths to MCP servers
38+
config.mcps_config_path = "../mcps.yml"
39+
40+
# Connection Pool for HTTP and SSE transports
41+
config.max_connections = 10
42+
config.pool_timeout = 5
43+
3744
# Configure roots for filesystem access
3845
config.roots = ["/path/to/project", Rails.root]
3946

docs/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,11 @@ permalink: /
1111
<iframe src="https://ghbtns.com/github-btn.html?user=patvice&repo=ruby_llm-mcp&type=star&count=true&size=large" frameborder="0" scrolling="0" width="170" height="30" title="GitHub" style="vertical-align: middle; display: inline-block;"></iframe>
1212
</div>
1313

14+
<div class="badge-container">
15+
<a href="https://badge.fury.io/rb/ruby_llm-mcp"><img src="https://badge.fury.io/rb/ruby_llm-mcp.svg" alt="Gem Version" /></a>
16+
<a href="https://rubygems.org/gems/ruby_llm-mcp"><img alt="Gem Downloads" src="https://img.shields.io/gem/dt/ruby_llm-mcp"></a>
17+
</div>
18+
1419
A Ruby client for the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) that seamlessly integrates with [RubyLLM](https://github.com/crmne/ruby_llm). This gem enables Ruby applications to connect to MCP servers and use their tools, resources, and prompts as part of LLM conversations.
1520

1621
Currently supports MCP protocol version up to `2025-06-18`

0 commit comments

Comments
 (0)