From 4a0b34af72ce093b2f4db84fc842f0b4d5963788 Mon Sep 17 00:00:00 2001 From: Dawid Rycerz Date: Thu, 29 May 2025 09:15:23 +0200 Subject: docs: update README files with correct repository URL and MCP server usage instructions - Update repository URL from GitHub to Codeberg (https://codeberg.org/knightdave/dawids-mcp-servers.git) - Add recommended uv command usage for running MCP servers from repository root - Update examples for both gitlab_glab and hello_world servers - Maintain backward compatibility with alternative running methods - Clean up installation instructions and remove outdated references --- README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 259021f..8ffb0fd 100644 --- a/README.md +++ b/README.md @@ -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 -- cgit v1.2.3