Skip to content

Commit 9f1fffc

Browse files
authored
Merge pull request #122 from patvice/issue-readme-update
Docs refresh: README/index rewrite, examples, and issue template
2 parents 228ad0c + e4b86ac commit 9f1fffc

File tree

4 files changed

+328
-435
lines changed

4 files changed

+328
-435
lines changed
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
name: Bug report
3+
about: Report a bug or regression in RubyLLM::MCP
4+
title: "[Bug]: "
5+
labels: bug, needs-triage
6+
---
7+
8+
> If you have a MCP example where you had an issue, please include it.
9+
> A small reproducible MCP example makes debugging much faster.
10+
> Include a quick ruby script with your MCP and failure to be able to reproduce helpful as well.
11+
12+
## Summary
13+
14+
What happened?
15+
16+
## Expected behavior
17+
18+
What did you expect to happen?
19+
20+
## Actual behavior
21+
22+
What actually happened? Include error messages and stack traces if possible.
23+
24+
## Minimal reproducible example (include MCP example)
25+
26+
```ruby
27+
require "ruby_llm/mcp"
28+
29+
# Paste a small runnable example here
30+
```
31+
32+
## Environment (optional - delete any lines not relevant)
33+
34+
- `ruby_llm-mcp` version:
35+
- Ruby version:
36+
- Adapter (`:ruby_llm` / `:mcp_sdk`):
37+
- Transport (`stdio` / `streamable` / `sse`):
38+
- MCP server + version:
39+
40+
## Logs / output (optional)
41+
42+
```text
43+
Paste logs here
44+
```
45+
46+
## Additional context (optional)
47+
48+
Anything else that may help debug this.

.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,8 @@ Gemfile.lock
1919

2020
node_modules/
2121
.vcr_debug.log
22+
23+
# AI specific files
24+
CLAUDE.md
25+
.claude
26+
AGENTS.md

0 commit comments

Comments
 (0)