diff options
| author | knightdave <knightdave@noreply.codeberg.org> | 2025-05-29 09:16:52 +0200 |
|---|---|---|
| committer | knightdave <knightdave@noreply.codeberg.org> | 2025-05-29 09:16:52 +0200 |
| commit | 2778e2fd17fc205248a73ba97e6ef23ad26aaed1 (patch) | |
| tree | dff289c0d6593f3347c751a90999645a9b859452 /servers/hello_world | |
| parent | 07db2730881114a94ce9ec92f6cb39794f931f72 (diff) | |
| parent | 4a0b34af72ce093b2f4db84fc842f0b4d5963788 (diff) | |
Merge pull request 'docs: update README files with correct repository URL and MCP server usage instructions' (#2) from feature/update-documentation into main
Reviewed-on: https://codeberg.org/knightdave/dawids-mcp-servers/pulls/2
Diffstat (limited to 'servers/hello_world')
| -rw-r--r-- | servers/hello_world/README.md | 42 |
1 files changed, 23 insertions, 19 deletions
diff --git a/servers/hello_world/README.md b/servers/hello_world/README.md index 6c93215..cb7b16c 100644 --- a/servers/hello_world/README.md +++ b/servers/hello_world/README.md @@ -14,42 +14,46 @@ This server provides: ```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 . +git clone https://codeberg.org/knightdave/dawids-mcp-servers.git +cd dawids-mcp-servers ``` ## Usage -### Running the Server - -You can run the server with either stdio or remote transport: +### Running from repository root (recommended) ```bash -# Run with stdio transport (default) -python -m mcp_server_hello_world +# Run with stdio transport (for MCP client integration) +uv --directory /path-to-repo/dawids-mcp-servers/servers/hello_world run mcp-hello-world --transport stdio -# 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 +# Run with remote transport +uv --directory /path-to-repo/dawids-mcp-servers/servers/hello_world run mcp-hello-world --transport remote --host 0.0.0.0 --port 8080 ``` -### Using with Claude Desktop +Replace `/path-to-repo` with the actual path to where you cloned this repository. -To install the server in Claude Desktop: +### Alternative: Running from server directory ```bash -mcp install /path/to/servers/hello_world +cd servers/hello_world + +# Run with stdio transport +uv run mcp-hello-world --transport stdio + +# Run with remote transport +uv run mcp-hello-world --transport remote --host 0.0.0.0 --port 8080 ``` -### Development Mode +### Legacy methods -For development and testing: +You can also run the server using Python module syntax: ```bash -mcp dev /path/to/servers/hello_world +# 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 ``` ## API Reference |