From d6c1f9a280ff75b5781519be947185796e0a2382 Mon Sep 17 00:00:00 2001 From: Hermes Agent Date: Sun, 2 Aug 2026 17:23:55 +0200 Subject: [PATCH] docs: add uvx MCP installation path --- README.md | 31 ++++++++++++++++++++++---- examples/hermes-openherbarium-uvx.yaml | 14 ++++++++++++ 2 files changed, 41 insertions(+), 4 deletions(-) create mode 100644 examples/hermes-openherbarium-uvx.yaml diff --git a/README.md b/README.md index 890698e..c4fbf32 100644 --- a/README.md +++ b/README.md @@ -127,7 +127,29 @@ No paid API is required. - Python 3.11+ - `uv` recommended, or any Python package installer capable of creating a virtual environment -### Local install with `uv` +### Simplest install: run directly with `uvx` + +You do not need to clone the repository manually. Hermes can let `uvx` install +and run the MCP server directly from Gitea: + +```yaml +mcp_servers: + openherbarium: + command: "uvx" + args: + - "--from" + - "git+https://git.home-deneuville.fr/Edern/openherbarium-mcp.git" + - "openherbarium-mcp" + timeout: 120 + connect_timeout: 60 +``` + +Restart Hermes Agent after editing `~/.hermes/config.yaml`. + +An equivalent ready-to-copy snippet is available at +[`examples/hermes-openherbarium-uvx.yaml`](examples/hermes-openherbarium-uvx.yaml). + +### Development install with `uv` ```bash git clone https://git.home-deneuville.fr/Edern/openherbarium-mcp.git @@ -141,15 +163,16 @@ Run tests: uv run pytest ``` -Run the MCP server over stdio: +Run the MCP server over stdio from the checked-out project: ```bash uv run openherbarium-mcp ``` -## Hermes Agent configuration +## Hermes Agent configuration for local development -Add the server to `~/.hermes/config.yaml`: +If you want to work on the source code locally instead of using the `uvx` setup, +add the checked-out server to `~/.hermes/config.yaml`: ```yaml mcp_servers: diff --git a/examples/hermes-openherbarium-uvx.yaml b/examples/hermes-openherbarium-uvx.yaml new file mode 100644 index 0000000..aa6facf --- /dev/null +++ b/examples/hermes-openherbarium-uvx.yaml @@ -0,0 +1,14 @@ +# Drop this under ~/.hermes/config.yaml -> mcp_servers +# No manual clone is required: uvx installs/runs OpenHerbarium MCP from Gitea. +openherbarium: + command: "uvx" + args: + - "--from" + - "git+https://git.home-deneuville.fr/Edern/openherbarium-mcp.git" + - "openherbarium-mcp" + timeout: 120 + connect_timeout: 60 + # Optional, only needed for targeted source search: + # env: + # FIRECRAWL_API_URL: "http://localhost:3002" + # FIRECRAWL_API_KEY: ""