summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorknightdave <knightdave@noreply.codeberg.org>2025-05-29 09:16:52 +0200
committerknightdave <knightdave@noreply.codeberg.org>2025-05-29 09:16:52 +0200
commit2778e2fd17fc205248a73ba97e6ef23ad26aaed1 (patch)
treedff289c0d6593f3347c751a90999645a9b859452 /README.md
parent07db2730881114a94ce9ec92f6cb39794f931f72 (diff)
parent4a0b34af72ce093b2f4db84fc842f0b4d5963788 (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 'README.md')
-rw-r--r--README.md34
1 files changed, 34 insertions, 0 deletions
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