Jannik/PaperClipAI
1
0 Fork 0
mirror of https://github.com/paperclipai/paperclip.git synced 2026-10-11 14:10:50 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
codex/plugin-task-execution
PaperClipAI/doc/HERMES_GATEWAY_SMOKE.md
T
DottaandPaperclip fd2f82ac5b [codex] Add built-in Hermes adapters (#8543) 
## Thinking Path

> - Paperclip is the open source app people use to manage AI agents for
work.
> - Agent adapters are the boundary between the control plane and the
runtimes that actually do work.
> - Hermes support needs to be available as first-class local and
gateway adapters while still preserving the adapter-manager override
path for external packages.
> - The adapter work touches runtime execution, UI adapter metadata,
onboarding prompts, scoped credentials, release packaging, and smoke
coverage, so the handoff needs concrete verification rather than only
unit tests.
> - This pull request adds built-in Hermes local and Hermes gateway
support, keeps external adapter overrides compatible, and
documents/tests the gateway flow end to end.
> - The benefit is that operators can hire Hermes-backed agents without
a manual plugin install, while self-hosted installs can still
override/shadow the built-ins through Adapter manager packages.

## Linked Issues or Issue Description

No public GitHub issue exists for this exact Hermes built-in adapter,
gateway onboarding, and release-source work.

Problem description:
- Hermes local and gateway adapters need a public, reviewable source
path in the monorepo so package artifacts and built-in adapter behavior
match the application source.
- Operators need built-in `hermes_local` and `hermes_gateway` adapter
choices without losing the ability to install external Hermes packages
as overrides.
- Gateway onboarding needs secure defaults for API server URLs, API
keys, and generated agent setup text.
- Hermes-originated task bridge credentials need narrower API-key scope
configuration.
- Related public PRs found during duplicate search include #3027, #2363,
#7544, #7950, #8095, and #8543.

## What Changed

- Added the unified Hermes adapter package with local and gateway
server/UI/CLI exports, config schemas, transcript parsing, model
detection, and package metadata.
- Registered `hermes_local` and `hermes_gateway` as built-in adapters
across shared constants, server registries, CLI packaging, and UI
adapter registries.
- Kept the external adapter override path compatible so installed Hermes
packages can shadow built-ins and restore the built-in parser when
disabled.
- Added Hermes gateway onboarding docs, board-operator docs, Docker
smoke assets, and shell smoke harnesses for join/e2e validation.
- Added scoped task-bridge API-key support, authorization checks,
issue-origin handling, and tests for Hermes-created Paperclip tasks.
- Hardened gateway transport and redaction behavior for API keys,
headers, session data, and smoke diagnostics.
- Updated release packaging/bootstrap checks for the Hermes packages
while leaving `pnpm-lock.yaml` out of the PR per repository policy.

## Verification

Targeted local verification recorded before PR handoff:
- `pnpm --filter @paperclipai/hermes-paperclip-adapter exec vitest run
src/gateway/server/execute.test.ts` — 14/14 passed.
- `pnpm test:hermes-gateway-smoke` — 6/6 passed.
- Hermes package typecheck/build checks passed.
- Focused server/UI adapter tests passed — 31/31.
- Release helper Node tests passed — 18/18.
- `git diff --check origin/master..HEAD` passed.

Fresh Docker E2E smoke evidence:
- Ran `pnpm smoke:hermes-gateway-e2e` on 2026-06-26 with a fresh state
directory and fresh Docker container against a live Paperclip dev
server.
- Hermes direct execution reached `completed`.
- Hermes stop/cancel path reached `cancelled`.
- Hermes gateway created a Paperclip task, Paperclip ran the Hermes
agent, and the task reached `done` with the expected marker response.
- Temporary board auth keys, token files, smoke state, and Docker
containers were cleaned up after the run.

PR checks on head `b5eae40ce`:
- GitHub Actions passed: `policy`, `review`, `Typecheck + Release
Registry`, all general test shards, all serialized server shards,
`Build`, `Canary Dry Run`, `e2e`, and aggregate `verify`.
- External checks passed: Snyk and Socket Project Report.
- External Socket Pull Request Alerts remained pending after the
first-party CI matrix completed.

## Risks

- Medium risk: this spans adapter registration, package publishing,
gateway execution, onboarding docs, API-key scoping, and UI adapter
metadata.
- Migration risk is low: the scope-config migration adds a nullable
column and does not rewrite existing keys.
- Gateway execution depends on operator-provided Hermes API
configuration; the smoke covers the Docker gateway path but real
deployments may differ by network/auth setup.
- Direct Greptile review on the latest expanded diff is file-count
limited, although the commitperclip review gate passed.

> For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and
discuss it in `#dev` before opening the PR. Feature PRs that overlap
with planned core work may need to be redirected — check the roadmap
first. See `CONTRIBUTING.md`.

## Model Used

OpenAI Codex, GPT-5 coding agent, tool use enabled in a local repository
workspace. Context window size is not exposed in this environment.

## Checklist

- [x] I have included a thinking path that traces from project context
to this change
- [x] I have specified the model used (with version and capability
details)
- [x] I have checked ROADMAP.md and confirmed this PR does not duplicate
planned core work
- [x] I have searched GitHub for duplicate or related PRs and linked
them above
- [x] I have either (a) linked existing issues with `Fixes: #` / `Closes
#` / `Refs #` OR (b) described the issue in-PR following the relevant
issue template
- [x] I have not referenced internal/instance-local Paperclip issues or
links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip`
URLs)
- [x] My branch name describes the change (e.g. `docs/...`, `fix/...`)
and contains no internal Paperclip ticket id or instance-derived details
- [x] I have run tests locally and they pass
- [x] I have added or updated tests where applicable
- [x] I have updated relevant documentation to reflect my changes
- [x] I have considered and documented any risks above
- [x] All Paperclip CI gates are green
- [x] Commitperclip review gate is green; direct Greptile review is
file-count limited on the latest expanded diff
- [x] I will address all Greptile and reviewer comments before
requesting merge

---------

Co-authored-by: Paperclip <noreply@paperclip.ing>
2026-06-26 16:04:58 -05:00

169 lines
6.7 KiB
Markdown
Raw Permalink Blame History

# Hermes Gateway Smoke
This smoke validates the built-in `hermes_gateway` adapter against a fresh
Hermes gateway. Keep real Hermes execution manual/local: the CI-safe checks only
lint shell syntax and focused helper behavior.
For the operator-facing install and invite flow, see
[HERMES_GATEWAY_ONBOARDING.md](./HERMES_GATEWAY_ONBOARDING.md). This smoke guide
focuses on verification commands and network modes.
## CI-safe validation
Run these from the repo root:
```sh
bash -n scripts/smoke/hermes-gateway-join.sh scripts/smoke/hermes-gateway-e2e.sh
pnpm test:hermes-gateway-smoke
```
`pnpm test:hermes-gateway-smoke` does not start Docker, Hermes, or Paperclip. It
checks script help output, shell syntax, redaction helpers, URL slash handling,
and the non-loopback HTTP guard.
## Secrets and cleanup
- Set the Hermes gateway key with `HERMES_GATEWAY_API_KEY` or `API_SERVER_KEY`.
The scripts print only `sha256=<prefix>` and length for secret identifiers.
- Set at least one Hermes inference provider key on the host before running the
Docker E2E smoke. The script passes through set values for
`OPENROUTER_API_KEY`, `OPENAI_API_KEY`, `ANTHROPIC_API_KEY`, `GEMINI_API_KEY`,
`GOOGLE_API_KEY`, and `MISTRAL_API_KEY`, and logs only the provider env var
names.
- To pin the fresh Hermes container to a known non-secret model config, set
`HERMES_SMOKE_MODEL_PROVIDER`, `HERMES_SMOKE_MODEL_DEFAULT`, and optionally
`HERMES_SMOKE_MODEL_BASE_URL`. For example, OpenRouter GLM:
```sh
HERMES_SMOKE_MODEL_PROVIDER=openrouter \
HERMES_SMOKE_MODEL_DEFAULT=z-ai/glm-5.2 \
HERMES_SMOKE_MODEL_BASE_URL=https://openrouter.ai/api/v1 \
pnpm smoke:hermes-gateway-e2e
```
This writes only `model`, `providers: {}`, and
`command_allowlist: [execute_code]` into the temporary Hermes home. Provider
keys still come from environment variables and are redacted from diagnostics.
- The E2E helper always seeds `command_allowlist: [execute_code]` in the fresh
Hermes config so non-interactive gateway/API runs do not wait for a manual
execute-code approval prompt. Do not copy a host `~/.hermes` directory into
the container to solve approval or provider setup.
- Board/operator auth is required through `PAPERCLIP_AUTH_HEADER`,
`PAPERCLIP_COOKIE`, or a board-capable `PAPERCLIP_API_KEY`.
- Diagnostic files are redacted before they are written, except the join output
file intentionally contains the claimed Paperclip agent key and is written
`chmod 600`.
- Successful runs remove the smoke issue, smoke agent, join request, Docker
container, and per-run local state.
- Set `HERMES_SMOKE_KEEP=1` to preserve diagnostics, state, and the container.
Failed runs automatically preserve them and print the retained paths.
## URL model
The smoke has three URLs because different processes need different routes:
- `PAPERCLIP_API_URL`: Paperclip URL used by the operator shell.
- `PAPERCLIP_API_URL_FOR_HERMES`: Paperclip URL used from inside the Hermes
container or remote Hermes host.
- `HERMES_GATEWAY_API_BASE_URL`: Hermes gateway URL stored on the Paperclip
adapter, reachable by the Paperclip server.
- `HERMES_GATEWAY_PROBE_URL`: Hermes gateway URL used by the operator shell for
direct `/health`, `/v1/capabilities`, `/v1/runs`, and SSE checks.
Loopback HTTP gateway URLs are allowed. Non-loopback HTTP gateway URLs require
`HERMES_GATEWAY_ALLOW_INSECURE_HTTP=1` and should only be used on local/private
development networks. Use HTTPS for real remote gateways.
## Docker Desktop or Linux host Paperclip
Use this when Paperclip runs on the host at `127.0.0.1:3100` and Docker can
reach the host through `host.docker.internal`.
```sh
PAPERCLIP_API_URL=http://127.0.0.1:3100 \
PAPERCLIP_AUTH_HEADER='Bearer <board-token>' \
pnpm smoke:hermes-gateway-e2e
```
Linux uses `--add-host=host.docker.internal:host-gateway` by default through
`HERMES_DOCKER_ADD_HOST=1`. If your Docker setup already provides
`host.docker.internal`, the same command works.
## Same Docker network as Paperclip
Use this when Paperclip is a container on a Docker network and the Hermes smoke
container should be reachable by container DNS. The operator shell still probes
the host-published loopback port.
```sh
PAPERCLIP_API_URL=http://127.0.0.1:3100 \
PAPERCLIP_AUTH_HEADER='Bearer <board-token>' \
HERMES_CONTAINER_NAME=paperclip-hermes-gateway-smoke \
HERMES_SMOKE_NETWORK=paperclip_default \
HERMES_DOCKER_ADD_HOST=0 \
HERMES_GATEWAY_API_BASE_URL=http://paperclip-hermes-gateway-smoke:8642 \
HERMES_GATEWAY_PROBE_URL=http://127.0.0.1:8642 \
PAPERCLIP_API_URL_FOR_HERMES=http://paperclip:3100 \
HERMES_GATEWAY_ALLOW_INSECURE_HTTP=1 \
pnpm smoke:hermes-gateway-e2e
```
Change `paperclip_default` and `paperclip` to your Compose network and service
name. The unsafe HTTP flag is required because Paperclip stores a non-loopback
`http://` gateway URL for private Docker DNS.
## LAN or private-network Paperclip
Use this when Paperclip is exposed on a private IP or tailnet address and the
Hermes container can reach that address.
```sh
PAPERCLIP_API_URL=http://192.168.1.20:3100 \
PAPERCLIP_AUTH_HEADER='Bearer <board-token>' \
PAPERCLIP_API_URL_FOR_HERMES=http://192.168.1.20:3100 \
HERMES_GATEWAY_API_BASE_URL=http://192.168.1.20:8642 \
HERMES_GATEWAY_PROBE_URL=http://127.0.0.1:8642 \
HERMES_GATEWAY_ALLOW_INSECURE_HTTP=1 \
pnpm smoke:hermes-gateway-e2e
```
Only use this on a trusted private network. For anything beyond local/private
development, put the Hermes gateway behind TLS and use the reverse-proxy mode.
## Reverse proxy / TLS
Use this when Paperclip should talk to Hermes through a TLS hostname. The smoke
container still publishes a local port, and your reverse proxy forwards the TLS
hostname to that port.
```sh
PAPERCLIP_API_URL=https://paperclip.example.com \
PAPERCLIP_AUTH_HEADER='Bearer <board-token>' \
PAPERCLIP_API_URL_FOR_HERMES=https://paperclip.example.com \
HERMES_GATEWAY_API_BASE_URL=https://hermes-gateway.example.com \
HERMES_GATEWAY_PROBE_URL=http://127.0.0.1:8642 \
pnpm smoke:hermes-gateway-e2e
```
No unsafe HTTP escape hatch is needed because the adapter URL is HTTPS.
## Join-only validation
If a Hermes gateway is already running, use the join helper without building or
starting a Docker container:
```sh
API_SERVER_ENABLED=true API_SERVER_KEY='<gateway-key>' hermes gateway run --replace --accept-hooks
PAPERCLIP_API_URL=http://127.0.0.1:3100 \
PAPERCLIP_AUTH_HEADER='Bearer <board-token>' \
HERMES_GATEWAY_API_BASE_URL=http://127.0.0.1:8642 \
HERMES_GATEWAY_API_KEY='<gateway-key>' \
pnpm smoke:hermes-gateway-join
```
For non-loopback private HTTP join-only runs, set
`HERMES_GATEWAY_ALLOW_INSECURE_HTTP=1`. For Docker DNS or reverse-proxy setups,
set `HERMES_GATEWAY_PROBE_URL` to the URL reachable from the operator shell and
`HERMES_GATEWAY_API_BASE_URL` to the URL Paperclip should store on the adapter.
Reference in new issue View Git Blame Copy Permalink