Skip to content

docs: refresh recent behavior notes#262

Open
poe-code-agent[bot] wants to merge 7 commits into
mainfrom
agent/update-documentation
Open

docs: refresh recent behavior notes#262
poe-code-agent[bot] wants to merge 7 commits into
mainfrom
agent/update-documentation

Conversation

@poe-code-agent
Copy link
Copy Markdown
Contributor

@poe-code-agent poe-code-agent Bot commented Apr 29, 2026

Summary

  • Document recent provider behavior: provider login --base-url, shape-specific endpoint storage, required Cloudflare gateway URLs, and freeform provider model handling.
  • Refresh Codex E2E assertion docs for the active top-level model defaults, profile values, and current Poe API base URL.
  • Keep the existing package README refreshes on this documentation branch for task-list, harness, telemetry, agent-spawn, workflow, config, and Toolcraft behavior.

Verification

  • Reviewed the 8 commits that landed on origin/main in the last 24 hours as of 2026-05-23 UTC.
  • Verified documentation claims against 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, and packages/providers/src/providers/poe.ts.
  • npx prettier --check packages/providers/README.md
  • git diff --check origin/main...HEAD

@poe-code-agent poe-code-agent Bot force-pushed the agent/update-documentation branch from 1846751 to 1717f39 Compare April 29, 2026 00:33
Copy link
Copy Markdown
Contributor Author

@poe-code-agent poe-code-agent Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Copy Markdown
Contributor Author

@poe-code-agent poe-code-agent Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@poe-code-agent poe-code-agent Bot force-pushed the agent/update-documentation branch from 1717f39 to 021fc50 Compare May 1, 2026 00:31
@poe-code-agent poe-code-agent Bot changed the title docs: document toolcraft group help parameters docs: refresh recent behavior notes May 1, 2026
Copy link
Copy Markdown
Contributor Author

@poe-code-agent poe-code-agent Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Requested changes: one Toolcraft CLI help note contradicts current output.

Comment thread packages/toolcraft/README.md Outdated
@poe-code-agent poe-code-agent Bot force-pushed the agent/update-documentation branch from 021fc50 to 888fc84 Compare May 4, 2026 00:27
Copy link
Copy Markdown
Contributor Author

@poe-code-agent poe-code-agent Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Requested changes: Toolcraft help docs still contradict positional rendering.

Comment thread packages/toolcraft/README.md Outdated

**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.
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 poe-code-agent Bot force-pushed the agent/update-documentation branch from 1e78578 to bb293d4 Compare May 14, 2026 00:33
Copy link
Copy Markdown
Contributor Author

@poe-code-agent poe-code-agent Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@poe-code-agent poe-code-agent Bot force-pushed the agent/update-documentation branch from bb293d4 to c6fa8e6 Compare May 16, 2026 00:31
Copy link
Copy Markdown
Contributor Author

@poe-code-agent poe-code-agent Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Requested changes: public API docs list non-exported behavior.


## 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.
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@poe-code-agent poe-code-agent Bot force-pushed the agent/update-documentation branch from c6fa8e6 to 815a869 Compare May 23, 2026 00:36
Copy link
Copy Markdown
Contributor Author

@poe-code-agent poe-code-agent Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Requested changes: docs still describe behavior/API that is not present.


## 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.
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

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.
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

archivePlan() does not repack active prefixes; the current test explicitly expects archiving to leave 01-first.md and 03-third.md in place.

Suggested change
- `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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant