docs: refresh recent behavior notes#262
Open
poe-code-agent[bot] wants to merge 6 commits into
Open
Conversation
poe-code-agent
Bot
force-pushed
the
agent/update-documentation
branch
from
1846751 to
1717f39
Compare
![poe-code-agent[bot]](https://avatars.githubusercontent.com/in/2645587?s=60&v=4){kind=small}
poe-code-agent
Bot
force-pushed
the
agent/update-documentation
branch
from
1717f39 to
021fc50
Compare
poe-code-agent
Bot
changed the title
poe-code-agent
Bot
force-pushed
the
agent/update-documentation
branch
from
021fc50 to
888fc84
Compare
|
|
||
| **Tree**: the `root` group is a `defineGroup` whose children are commands and sub-groups. Any depth. CLI flags, MCP tool names, and SDK methods are derived from the path. | ||
|
|
||
| **CLI help**: group help lists visible child commands with their parameter tokens inline. Required options appear as `--name <type>`, optional options and defaults appear in brackets like `[--limit <number>]`, and positional parameters stay unbracketed even when the underlying schema field is optional. Command-specific `--help` still shows the detailed parameter table. |
Contributor
Author
There was a problem hiding this comment.
This still contradicts the current formatter: formatHelpFieldFlags() uses formatPositionalToken() for positional fields, and formatPositionalToken() wraps optional/default positionals in brackets (for example [agent]).
Suggested change
| **CLI help**: group help lists visible child commands with their parameter tokens inline. Required options appear as `--name <type>`, optional options and defaults appear in brackets like `[--limit <number>]`, and positional parameters stay unbracketed even when the underlying schema field is optional. Command-specific `--help` still shows the detailed parameter table. | |
| **CLI help**: group help lists visible child commands with their parameter tokens inline. Required options appear as `--name <type>`, optional options and defaults appear in brackets like `[--limit <number>]`, and positional parameters render as `<name>` or `[name]` depending on whether the underlying schema field is required. Command-specific `--help` still shows the detailed parameter table. |
poe-code-agent
Bot
force-pushed
the
agent/update-documentation
branch
from
1e78578 to
bb293d4
Compare
Co-authored-by: poe-code-agent[bot] <254571472+poe-code-agent[bot]@users.noreply.github.com>
poe-code-agent
Bot
force-pushed
the
agent/update-documentation
branch
from
bb293d4 to
c6fa8e6
Compare
|
|
||
| ## Trace shape | ||
|
|
||
| `acpToTrace` creates one root `agent:<agent>:<model>` span with redacted prompt input, accumulated assistant output, token/cost/duration metrics when present, session/thread metadata, and one child span per ACP tool call. Tool child spans include redacted inputs, assembled tool outputs, tool call metadata, and start/end timestamps when the ACP event metadata includes them. |
Contributor
Author
There was a problem hiding this comment.
acpToTrace does not currently include any cost metric from ctx.usage (it only maps token counts/cache counts and durationMs in buildMetrics), so documenting cost here is misleading.
Suggested change
| `acpToTrace` creates one root `agent:<agent>:<model>` span with redacted prompt input, accumulated assistant output, token/cost/duration metrics when present, session/thread metadata, and one child span per ACP tool call. Tool child spans include redacted inputs, assembled tool outputs, tool call metadata, and start/end timestamps when the ACP event metadata includes them. | |
| `acpToTrace` creates one root `agent:<agent>:<model>` span with redacted prompt input, accumulated assistant output, token/duration metrics when present, session/thread metadata, and one child span per ACP tool call. Tool child spans include redacted inputs, assembled tool outputs, tool call metadata, and start/end timestamps when the ACP event metadata includes them. |
| - `listBuiltinTemplates()` returns bundled template pairs: `ralph-demo`, `coverage-demo`, `experiment-demo`, `pipeline-demo`, and `superintendent-demo`. | ||
| - `extractSchema(source, filename)` reads a harness script's exported schema for frontmatter validation. | ||
| - `resolvePair(mdPath)` resolves the Markdown/script pair for a harness document. | ||
| - `LintError` wraps lint diagnostics raised before execution. |
Contributor
Author
There was a problem hiding this comment.
LintError is declared in loader/run.ts, but packages/agent-harness/src/index.ts does not re-export it and the package only exports dist/index.js. Either export it from the public entrypoint or drop this public API bullet.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Verification
origin/mainin the last 24 hours as of 2026-05-16 00:27 UTC (130commits).packages/task-list/src,packages/agent-harness/src,packages/acp-telemetry/src,packages/agent-spawn/src,packages/agent-maestro/src,src/cli, andpackages/toolcraft/src.npx prettier --check packages/acp-telemetry/README.md packages/agent-harness-tools/README.md packages/agent-harness/README.md packages/agent-maestro/README.md packages/agent-spawn/README.md packages/task-list/README.md packages/toolcraft/README.mdgit diff --check