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,32 @@
|
|||
# A Simple MCP weather Server written in TypeScript
|
||||
# A Simple MCP Weather Server written in TypeScript
|
||||
|
||||
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
|
||||
|
||||
- Node.js 24+
|
||||
- npm
|
||||
|
||||
## Build and run
|
||||
|
||||
```bash
|
||||
npm install
|
||||
npm run build
|
||||
node build/index.js
|
||||
```
|
||||
|
||||
The server communicates over stdio, so running it directly just waits for a client on stdin. To see it in action, launch it from one of the client examples in this repository, for example:
|
||||
|
||||
```bash
|
||||
cd ../mcp-client-typescript
|
||||
npm install && npm run build
|
||||
node build/index.js ../weather-server-typescript/build/index.js
|
||||
```
|
||||
|
||||
## Structured content
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue