diff options
Diffstat (limited to 'servers/hello_world/README.md')
| -rw-r--r-- | servers/hello_world/README.md | 80 |
1 files changed, 80 insertions, 0 deletions
diff --git a/servers/hello_world/README.md b/servers/hello_world/README.md new file mode 100644 index 0000000..6c93215 --- /dev/null +++ b/servers/hello_world/README.md @@ -0,0 +1,80 @@ +# Hello World MCP Server + +A simple MCP server that demonstrates the basic functionality of the Model Context Protocol (MCP). + +## Features + +This server provides: + +1. A static resource with a welcome message +2. A simple "hello" tool that returns a greeting message +3. A greeting prompt template + +## Installation + +```bash +# Clone the repository +git clone https://github.com/your-username/dawids-mcp-servers.git +cd dawids-mcp-servers/servers/hello_world + +# Create a virtual environment and install dependencies +uv venv +uv pip install -e . +``` + +## Usage + +### Running the Server + +You can run the server with either stdio or remote transport: + +```bash +# Run with stdio transport (default) +python -m mcp_server_hello_world + +# Run with remote transport on a specific host and port +python -m mcp_server_hello_world --transport remote --host 0.0.0.0 --port 8080 +``` + +### Using with Claude Desktop + +To install the server in Claude Desktop: + +```bash +mcp install /path/to/servers/hello_world +``` + +### Development Mode + +For development and testing: + +```bash +mcp dev /path/to/servers/hello_world +``` + +## API Reference + +### Resources + +- `hello://welcome` - Returns a welcome message + +### Tools + +- `hello` - Takes a `name` parameter and returns a personalized greeting + +### Prompts + +- `greeting` - Takes a `name` parameter and returns a greeting prompt template + +## Development + +### Running Tests + +```bash +cd /path/to/servers/hello_world +uv run pytest +``` + +## License + +MIT |
