This repository powers a “pond agent” (Cave Scribe) that answers lore questions via GitHub Issues + Actions.
- Protect the canon (lore sources must not be silently altered)
- Prevent distortion (no unreviewed edits to scrolls / indices)
- Limit credentials (shortest-lived, least-privilege tokens)
- Auditability (changes are reviewable and attributable)
GitHub Actions may use these secrets (as configured by the repo owner):
GEMINI_API_KEYGROQ_API_KEYMISTRAL_API_KEYOPENROUTER_API_KEY
Optional Telegram bridge:
TELEGRAM_TOKENTELEGRAM_CHAT_ID
If using a private canon repo (recommended):
LORE_REPO_TOKEN(read-only access to the privatelore-scrollsrepo)
- Never commit secrets to git.
- Never paste secrets into Issues.
- Prefer GitHub’s built-in
${{ github.token }}when writing back to this repo. - Any cross-repo access must be read-only unless explicitly required.
- The canonical lore source should live in a protected location (e.g., a private
lore-scrollsrepo). - This repo should consume canon read-only and generate derived artifacts:
data/*indexesdata/stats.json
If you believe credentials were exposed or canon was modified improperly:
- Rotate affected keys immediately.
- Disable the workflow temporarily.
- Open a private incident note (do not post secrets in public issues).