Add README + Quickstart sections for agent execution

2026-06-28 13:49:06 -04:00
parent 6a8a2c61da
commit 94b3bf84b4
3 changed files with 194 additions and 0 deletions
@@ -33,6 +33,67 @@ description: >
 - extra_auxiliary: array — Additional auxiliary tasks to configure (vision, compression, etc.)
 - output_dir: string — Where to write the config (default: "~/.hermes/profiles/<agent_name>/config.yaml")

+## Quickstart — How to Run This Contract
+
+### For the Agent Running This Contract
+
+Read this section first. It tells you exactly what to do.
+
+**When to run:**
+- Setting up a **new agent profile** for the first time
+- An **existing profile** is missing web search, firecrawl, or MCP configs
+- User says: `"apply the config template"` or `"fix my infra config"`
+- User says: `"configure <agent_name> with <model>"`
+
+**How to run (via OpenProse CLI):**
+```bash
+# Minimal — only agent name required
+prose run hermes-config-template agent_name=syslog-code
+
+# Full control
+prose run hermes-config-template \
+  agent_name=syslog-devops \
+  default_model=claude-sonnet-4 \
+  auxiliary_model=gemma-4-12b \
+  fallback_model=deepseek-chat \
+  fallback_provider=deepseek
+```
+
+### How to Follow the Template (Manual)
+
+If `prose` CLI is not available:
+
+1. **Fetch this contract:** `curl -sL https://git.sysloggh.net/SyslogSolution/prose-contracts/raw/branch/master/hermes-config-template.prose.md`
+2. **Open the target config.yaml** — the profile you're updating
+3. **Compare** each of the 5 required sections below against what exists in the profile
+4. **For each section:**
+   - If it says **SHARED INFRA — DO NOT CHANGE**: Copy the value exactly as shown
+   - If it says **USER CHOOSES**: Use the agent's assigned model/provider
+   - If missing entirely: Add the full section
+5. **Verify** every endpoint responds (see Verification section at the end)
+6. **Restart** the gateway
+
+### Decision Tree
+
+```
+What kind of profile is this?
+├── Main profile (~/.hermes/config.yaml)
+│   └── Replace web.*, mcp_servers.*, compression.*, auxiliary.*, custom_providers.*
+│   └── model.default + fallback: use current values (USER CHOOSES)
+│
+├── Worker profile (~/.hermes/profiles/<name>/config.yaml)
+│   ├── Does it have web.search_backend?
+│   │   ├── NO → Add the full web.* section (copy exactly)
+│   │   └── YES → Verify it points to the right IP
+│   ├── Does it have mcp_servers.ra-h-os?
+│   │   ├── NO → Add mcp_servers.* section (copy exactly)
+│   │   └── YES → Verify URL
+│   └── model.default: USE the worker's assigned model (don't copy main)
+│
+└── Non-Syslog profile (personal/lifestyle agent)
+    └── Skip — use default Hermes config or Tanko's config instead
+```
+
 ## Infrastructure Stack

 This template provisions the following shared infrastructure. Every agent should point to the same endpoints unless explicitly overridden.