Improve all readmes (#188)
* Improve all readmes * Address some of the comments
This commit is contained in:
parent
f26c52eab4
commit
9395583c49
1 changed files with 358 additions and 23 deletions
|
|
@ -1,6 +1,31 @@
|
|||
# A Simple MCP Weather Server written in Ruby
|
||||
|
||||
See the [Build an MCP server](https://modelcontextprotocol.io/docs/develop/build-server) tutorial for more information.
|
||||
A minimal MCP server that exposes US weather data from the [National Weather Service API](https://www.weather.gov/documentation/services-web-api) as two tools:
|
||||
|
||||
- `get_forecast` – get the forecast for a location (takes `latitude` and `longitude`)
|
||||
- `get_alerts` – get active weather alerts for a US state (takes a two-letter state code)
|
||||
|
||||
This example accompanies the [Build an MCP server](https://modelcontextprotocol.io/docs/develop/build-server) tutorial.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Ruby 3.4+ (3.3 also satisfies the gems)
|
||||
- Bundler
|
||||
|
||||
## Setup and run
|
||||
|
||||
```bash
|
||||
bundle install
|
||||
bundle exec ruby weather.rb
|
||||
```
|
||||
|
||||
The server communicates over stdio, so running it directly just waits for a client on stdin. To see it in action, launch it from the Ruby client example in this repository:
|
||||
|
||||
```bash
|
||||
cd ../mcp-client-ruby
|
||||
bundle install
|
||||
bundle exec ruby client.rb ../weather-server-ruby/weather.rb
|
||||
```
|
||||
|
||||
## Structured content
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue