Skip to content

Commit dad2d35

Browse files
Merge pull request #1 from offendingcommit/codex/agents-md-pointer-20260612
docs: refresh agent guidance
2 parents ab76b44 + dc0d7e0 commit dad2d35

2 files changed

Lines changed: 26 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# hermes-plugin-kit
2+
3+
Convention-correct helper library for registering `hermes-agent` plugin tools.
4+
This repository is an installable Python package, not a path-loaded runtime
5+
plugin.
6+
7+
## Working Rules
8+
9+
- Keep the public API centered on `@tool`, `register_all`, and the argument
10+
helpers exported from `hermes_plugin_kit`.
11+
- Preserve the Hermes tool schema convention: arguments live under
12+
`function.parameters`, never as flattened top-level schema fields.
13+
- Tool handlers must accept `(args, **kwargs)` and return JSON-compatible
14+
dictionaries unless deliberately returning an already-encoded string.
15+
- Keep validation errors instructive for model-facing callers, including the
16+
missing argument name and example when available.
17+
- Redact secret-looking values in logs and avoid logging full untrusted payloads.
18+
- Use `uv` and the Makefile for local development:
19+
`make install`, `make test`, `make test-one T=tests.test_kit.SchemaConventionTests`,
20+
and `make build`.
21+
22+
## Release Notes
23+
24+
When changing conventions or exported helpers, update `README.md` examples and
25+
tests together so consuming Hermes plugins have a reliable migration path.

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
@AGENTS.md

0 commit comments

Comments
 (0)