Skip to content

Commit 04e8a71

Browse files
anycodescodex
andauthored
docs: clarify provider usage and operation boundaries (#105)
* docs: align Provider guide with published entry points * docs: finalize Provider guide review evidence --------- Co-authored-by: Codex <codex@openai.com>
1 parent 7fe329b commit 04e8a71

6 files changed

Lines changed: 177 additions & 148 deletions

File tree

‎.agents/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,3 +131,5 @@ Builtin transport: [direct HTTP](notes/implemented/architecture/2026-10-18-nativ
131131
- [Managed native workflows](notes/implemented/feature/2026-10-24-managed-native-workflows.md) · [public a3 verification](evidence/verify/2026-10-24-python-a3-public-release.md).
132132
- [Application proxy token](notes/implemented/feature/2026-10-24-application-proxy-token.md) · [runtime verification](evidence/verify/2026-10-24-application-proxy-token.md).
133133
- [Accurate packaged installation guidance](notes/implemented/process/2026-10-24-package-installation-docs.md) · [public a5 release](evidence/verify/2026-10-24-python-a5-public-release.md).
134+
135+
- [Provider guide accuracy](notes/implemented/process/2026-10-24-provider-guide-accuracy.md) · [verification](evidence/verify/2026-10-24-provider-guide-accuracy.md).
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Verification: active Provider guide accuracy
2+
3+
- Date: 2026-10-24
4+
- Result: PASS for the scoped local documentation checks; full content-head CI and independent review passed; final record-head CI remains a merge gate.
5+
- Change: [Issue #104](https://github.com/Alibaba-Agent-Sandbox/python-sdk/issues/104), based on `7fe329b422c59c9b9854dad4f8399f6c7572eb22`.
6+
- Scope: bilingual `docs/*/guide/providers.md`, records and changelog. No runtime/package-version changes.
7+
8+
## What was verified
9+
10+
The installed public CLI 0.4.16 rejects `abx sandbox url placeholder` with exit 1 and `unknown command 'url'`. Its actual sandbox help has no standalone URL or timeout command. The public Python a5 environment exports ProviderSandbox with create, connect, kill, close and application_client, and network.resolve is asynchronous. The installer CLI passes verify_handshake by default after consent; low-level installer tests without that callback do not prove execution-free CLI installation.
11+
12+
## Commands and results
13+
14+
- `python -m pytest client-sdk/tests/test_providers/test_node_doctor.py client-sdk/tests/test_providers/test_manifest.py client-sdk/tests/test_api/test_network.py -q`: 86 passed in 1.00 seconds.
15+
- Parsed both guides' Python blocks with ast.parse and checked 40 relative link targets: passed after correcting an initially mistyped reference filename during editing.
16+
- `make hygiene`: passed.
17+
- `git diff --check`: passed; repository health: 106 PASS, 1 existing warning, 0 failures.
18+
- Independent cross-review: actual entries, both languages, four Python blocks per guide and all relative links checked with no blocking finding. The review caught and corrected an accidental product-name substitution before commit.
19+
20+
## Observable behavior and existing real evidence
21+
22+
[Public package pilot 40115231628](https://github.com/Alibaba-Agent-Sandbox/awesome-templates/actions/runs/40115231628) passed on Express and OpenSandbox with CLI 0.4.16 and Python client/server 0.3.1a5. It exercised source launch, named commands through CLI/Python/HTTP, wrong-token rejection, runtime source identity, process/file operations and confirmed removal of owned sandboxes/prepared artifacts. That run validates the unchanged runtime, not every command in the older speculative table.
23+
24+
This change deletes inaccurate mappings and links existing detailed guides. It does not add cloud behavior, rerun the 92-case matrix, or claim model/PTY/interpreter coverage. Previously merged evidence and historical design records remain intact.
25+
26+
## Cleanup and limitations
27+
28+
These document, parser and SDK introspection checks created no cloud resources. The illustrative creation example now cleans up its single owned sandbox; the connect example closes its client and directs the user to the launch guide for sandbox/build-artifact cleanup. Full cloud execution of every prose example is not claimed.
29+
30+
## Final review and checks
31+
32+
[Full CI 40117213161](https://github.com/Alibaba-Agent-Sandbox/python-sdk/actions/runs/40117213161) and [Docs links 40117213042](https://github.com/Alibaba-Agent-Sandbox/python-sdk/actions/runs/40117213042) passed on content head `6388ca05161b0d47c71d3cf3057c54e047ef8d34`. Final prose cleanup removes the environment-specific readiness shortcut and the untestable promise that every old output stays unchanged; it does not alter an entry point. Both complete example manifests also parsed successfully with the installed public a5 package. Python block parsing and relative targets were rechecked after the final deletions. The final commit must pass the same full CI before merge.
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Decision: Keep Provider usage guidance aligned with actual entry points
2+
3+
Status: implemented
4+
5+
## Problem
6+
7+
The active bilingual guide contradicts its own handshake section with an execution-free installation promise. It lists nonexistent CLI commands, mixes process execution with named application commands and claims Python image builds. A partial authoring manifest omits required operation declarations. Mixed public and internal Sandbox names make the provider extension ambiguous.
8+
9+
## Decision
10+
11+
Describe pre-consent static inspection and default post-consent verification accurately. Use the public ProviderSandbox name. Replace the speculative capability-to-command table with six actual task entries and existing reference links. Remove the environment-specific historical readiness shortcut and the unverifiable promise that every output stays unchanged. Link the maintained complete example manifest instead of duplicating an incomplete one. Show one owned sandbox with independent kill/close cleanup, and a complete OpenSandbox connection example after CLI preparation.
12+
13+
## API Design
14+
15+
N/A — no runtime or public API changes. Keep exec, rest and node plugins and the standard Sandbox/AsyncSandbox clients unchanged.
16+
17+
## Alternatives considered
18+
19+
- Keep the large table and add more state labels: repeats the mismatch and creates another maintenance source.
20+
- Add missing CLI commands to justify the table: expands product scope without a user requirement.
21+
- Change historical design records: obscures the original decisions; correct the active guide instead.
22+
23+
## Dependencies
24+
25+
Published CLI 0.4.16, Python client/server 0.3.1a5, existing workflow/server/API guides and example provider manifests.
26+
27+
## Test Strategy
28+
29+
Inspect the actual public CLI parser and published SDK exports. Parse Python snippets, check link targets and run existing network/manifest/doctor tests. Require repository health, hygiene, full current-head CI and docs checks. Reuse unchanged real public-package startup/call/cleanup evidence; no new cloud behavior is introduced.
30+
31+
## Acceptance criteria
32+
33+
- No invented URL/timeout command or Python source-build promise in this guide.
34+
- Consent and handshake descriptions agree with the installer.
35+
- Provider examples use the explicit public extension, valid links and cleanup.
36+
- Required checks and independent review pass before normal merge.
37+
38+
## Evidence
39+
40+
- [Issue #104](https://github.com/Alibaba-Agent-Sandbox/python-sdk/issues/104)
41+
- [Verification](../../../evidence/verify/2026-10-24-provider-guide-accuracy.md)

‎CHANGELOG.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/).
1010

1111
### Documentation
1212

13+
- Simplify the bilingual Provider guide to actual entry points, correct installation verification guarantees and link complete authoring manifests. / 将中英文 Provider 指南收敛到实际调用入口,修正安装验证承诺,并引用完整的编写示例。
14+
1315
- Record the public 0.3.1a5 pair, artifact digests, clean installation and preserved propagation failure; link the current installation decision and proxy runtime evidence. / 记录公开的 0.3.1a5 配套双包、产物摘要、新环境安装及保留的索引传播失败,补齐安装决策和代理运行验证索引。
1416

1517
### Fixed

0 commit comments

Comments
 (0)