Initial Commit

docs/setup/stackexchange.md

@@ -0,0 +1,29 @@
+# `OWUITOOLS_STACKEXCHANGE_KEY` — lifts the rate limit on `search_stackexchange`
+
+Two minutes. Free, instant, no approval. **Optional** — the tool works without it.
+
+## Why
+
+Keyless Stack Exchange allows **300 requests per day per IP**, shared by everyone using
+your assistant. A key raises it to **10,000 per day**. It is not a secret in the usual
+sense — it identifies an application, not a user, and grants no access to anything.
+
+## Steps
+
+1. Go to <https://stackapps.com/apps/oauth/register>.
+2. Fill in any name and description. For OAuth Domain, `localhost` is fine.
+3. Register. You are shown a **key** immediately.
+4. Copy the value labelled **Key** (not "Client Id", not "Client Secret").
+5. Put it in `configs/owuitools.env`:
+
+   ```
+   OWUITOOLS_STACKEXCHANGE_KEY=...
+   ```
+
+6. `docker compose up -d api`
+
+## Checking it
+
+```sh
+./tests/try-tool.sh search_stackexchange '{"query": "bash trap EXIT"}' | head -5
+```