docs: refresh recent behavior notes#262
Conversation
1846751 to
1717f39
Compare
1717f39 to
021fc50
Compare
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. |
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]).
| **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. |
1e78578 to
bb293d4
Compare
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. |
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.
| `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. |
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.
Co-authored-by: poe-code-agent[bot] <254571472+poe-code-agent[bot]@users.noreply.github.com>
c6fa8e6 to
815a869
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. |
There was a problem hiding this comment.
acpToTrace still does not emit a cost metric: buildMetrics() maps token counts/cache counts and durationMs, but not costUsd/cost. Keeping cost here makes the trace contract inaccurate.
| `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. |
There was a problem hiding this comment.
LintError is still not exported from packages/agent-harness/src/index.ts, and the package only exposes that entrypoint. Please either export it or remove it from the documented public API.
| `openPlanList`, `discoverPlans`, and `archivePlan` expose numbered Markdown plan folders through `@poe-code/task-list`. They resolve the configured plan directory with the same cwd/home rules as workflow docs, open it as a `markdown-dir` single-list named `plans`, and use `frontmatterMode: "passthrough"` so plan-specific metadata survives task updates. | ||
|
|
||
| - `discoverPlans({ cwd, homeDir, planDirectory, kinds? })` returns plan ids, names, kinds, absolute paths, and display paths. Numeric filename prefixes such as `04-api-shape-providers.md` are stripped from ids. | ||
| - `archivePlan({ cwd, homeDir, planDirectory, id })` fires the task-list `archive` event, moves the document under `archive/`, and repacks active plan prefixes. |
There was a problem hiding this comment.
archivePlan() does not repack active prefixes; the current test explicitly expects archiving to leave 01-first.md and 03-third.md in place.
| - `archivePlan({ cwd, homeDir, planDirectory, id })` fires the task-list `archive` event, moves the document under `archive/`, and repacks active plan prefixes. | |
| - `archivePlan({ cwd, homeDir, planDirectory, id })` fires the task-list `archive` event and moves the document under `archive/` without renumbering active plan prefixes. |
Summary
provider login --base-url, shape-specific endpoint storage, required Cloudflare gateway URLs, and freeform provider model handling.Verification
origin/mainin the last 24 hours as of 2026-05-23 UTC.src/cli/commands/provider.ts,src/cli/commands/shared.ts,packages/providers/src/providers/cloudflare.ts,src/templates/codex/config.toml.mustache,src/cli/constants.ts, andpackages/providers/src/providers/poe.ts.npx prettier --check packages/providers/README.mdgit diff --check origin/main...HEAD