diff options
| -rw-r--r-- | README.md | 34 | ||||
| -rw-r--r-- | servers/gitlab_glab/README.md | 26 | ||||
| -rw-r--r-- | servers/hello_world/README.md | 42 |
3 files changed, 74 insertions, 28 deletions
@@ -2,6 +2,18 @@ This repository is a monorepo that contains a collection of Model Context Protocol (MCP) servers that can be used to extend LLM agent capabilities. +## Repository + +This repository is hosted at: https://codeberg.org/knightdave/dawids-mcp-servers.git + +## Getting Started + +```bash +# Clone the repository +git clone https://codeberg.org/knightdave/dawids-mcp-servers.git +cd dawids-mcp-servers +``` + ## Project Structure ``` @@ -89,6 +101,28 @@ cd servers/server_name docker build -t server_name . ``` +### Using MCP Servers + +To use any of the MCP servers in this repository, you can run them using `uv` from the repository root: + +```bash +# Example: Run GitLab glab server +uv --directory /path-to-repo/dawids-mcp-servers/servers/gitlab_glab run mcp-gitlab-glab --transport stdio + +# Example: Run hello world server +uv --directory /path-to-repo/dawids-mcp-servers/servers/hello_world run mcp-hello-world --transport stdio +``` + +Replace `/path-to-repo` with the actual path to where you cloned this repository. + +### Repository + +This repository is hosted at: https://codeberg.org/knightdave/dawids-mcp-servers.git + +### Alternative: Running from server directory + +You can also run servers by navigating to their directory first: + Run a server with stdio transport: ```bash diff --git a/servers/gitlab_glab/README.md b/servers/gitlab_glab/README.md index cef74c2..1457cad 100644 --- a/servers/gitlab_glab/README.md +++ b/servers/gitlab_glab/README.md @@ -22,26 +22,34 @@ This MCP server provides integration with GitLab through the GitLab CLI (`glab`) ```bash # Clone the repository -git clone https://github.com/yourusername/dawids-mcp-servers.git +git clone https://codeberg.org/knightdave/dawids-mcp-servers.git cd dawids-mcp-servers - -# Install the server -cd servers/gitlab_glab -uv pip install -e . ``` ## Usage -### Running the server with stdio transport (for local development) +### Running from repository root (recommended) ```bash -mcp-gitlab-glab --transport stdio +# Run with stdio transport (for MCP client integration) +uv --directory /path-to-repo/dawids-mcp-servers/servers/gitlab_glab run mcp-gitlab-glab --transport stdio + +# Run with remote transport +uv --directory /path-to-repo/dawids-mcp-servers/servers/gitlab_glab run mcp-gitlab-glab --transport remote --host 0.0.0.0 --port 8080 ``` -### Running the server with remote transport +Replace `/path-to-repo` with the actual path to where you cloned this repository. + +### Alternative: Running from server directory ```bash -mcp-gitlab-glab --transport remote --host 0.0.0.0 --port 8080 +cd servers/gitlab_glab + +# Run with stdio transport +uv run mcp-gitlab-glab --transport stdio + +# Run with remote transport +uv run mcp-gitlab-glab --transport remote --host 0.0.0.0 --port 8080 ``` ## Available Tools 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 |