You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 64c0e5c
Browse filesBrowse the repository at this point in the historyBrowse files
# Verification: current documentation after compatibility removal
2
+
3
+
- Date: 2026-10-22
4
+
- Scope: contributor entry point, current English/Chinese guides and references, documentation indexes and changelog; runtime code is unchanged.
5
+
- Result: PASS for local documentation checks; latest-head remote CI remains required before merge.
6
+
7
+
## Behavior and sources
8
+
9
+
The maintainer requested one current project contract. Compare documentation with the merged native method signatures, provider-owned port hooks, official template API, single configuration registry and always-on server policy engine. Remove obsolete import/method/credential aliases, inert retry fields, old template API selectors and base64 transfer routes from current instructions. Standard upstream behavior and immutable historical engineering captures remain separately owned.
10
+
11
+
The implementation and real-component results are recorded in [original verification](2026-10-22-remove-legacy-compatibility.md) and [merged acceptance](2026-10-22-remove-legacy-acceptance.md). This documentation follow-up creates no cloud resources and performs no release or manual deployment.
- PASS: `make hygiene` — no local paths or credential-like strings.
17
+
- PASS: `git diff --check` — no whitespace errors.
18
+
- Reviewed current method signatures, policy token setup, file route ownership and configuration descriptors against the changed documentation. Retired names remain only as explicit rejection/removal descriptions or historical review material.
19
+
- The latest-head remote CI and Markdown-link checks remain mandatory; product/cloud results belong to the linked implementation evidence, not to these document checks.
Verified merged implementation: https://github.com/Alibaba-Agent-Sandbox/python-sdk/pull/85. The source merge commit is `d1a54f78e447bc67b90dbfdf48168b020275c871`.
Remove stale instructions that still advertised retired imports, credential aliases, retry settings, template selectors and server transfer routes. The current API references, provider boundary pages and contributor entry point describe the merged implementation.
Copy file name to clipboardExpand all lines: CHANGELOG.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,6 +8,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/).
8
8
9
9
## [Unreleased]
10
10
11
+
### Fixed
12
+
13
+
- Align contributor guidance and English/Chinese API, configuration and provider documentation with the removed project compatibility surface. / 同步贡献指南及中英文 API、配置和 Provider 文档,清除已删除项目兼容接口的旧说明。
14
+
11
15
### Removed
12
16
13
17
- Pre-release project compatibility: old template factories/APIs and selector flags, import aliases, migration commands, deprecated method aliases, old server transfer routes, custom AK/SK token exchange and implicit provider URL/port fallbacks.
Copy file name to clipboardExpand all lines: README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -50,7 +50,7 @@ Provider management operations are available through `agent_sandbox.providers.co
50
50
-**MCP server** — expose sandbox operations as MCP tools for LLM agents.
51
51
-**Declarative decorator** — `@sandbox` turns a plain function into a remote sandbox execution with automatic serialisation.
52
52
-**Session persistence** — save and restore sandbox state across runs.
53
-
-**E2B-shaped methods** — `agent_sandbox.compat` re-exports the standard Sandbox and AsyncSandbox; see [Migrate from E2B](docs/en/guide/migrate-from-e2b.md).
53
+
-**Standard sync/async clients** — `agent_sandbox`exports the standard Sandbox and AsyncSandbox; see [Migrate from E2B](docs/en/guide/migrate-from-e2b.md).
Copy file name to clipboardExpand all lines: docs/en/DESIGN.md
+1-2Lines changed: 1 addition & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ This repository holds the Python SDK as two lock-step PyPI distributions — `ag
14
14
15
15
### Core Principles
16
16
17
-
1.**Pinned standard behavior and explicit provider extensions** — Root `Sandbox` is synchronous; `AsyncSandbox` is asynchronous. Standard and interpreter clients follow the Alibaba-supported E2B baseline through an owned MIT source port. `agent_sandbox.compat` re-exports the standard clients. Provider/server/declarative extensions use `ProviderSandbox`; `ABX_PROVIDER` does not switch the standard clients' protocol.
17
+
1.**Pinned standard behavior and explicit provider extensions** — Root `Sandbox` is synchronous; `AsyncSandbox` is asynchronous. Standard and interpreter clients follow the Alibaba-supported E2B baseline through an owned MIT source port. Provider/server/declarative extensions use `ProviderSandbox`; `ABX_PROVIDER` does not switch the standard clients' protocol.
18
18
2.**AI-First** — MCP Server as a first-class citizen, coding agents hosted through the Agents API
19
19
3.**Explicit connection settings** — Reuse the existing Alibaba API key, API URL and sandbox domain; backend-dependent capabilities remain conditional.
20
20
@@ -128,7 +128,6 @@ Chinese copies of these pages live under `docs/zh/`. `repository-layout.md` is E
128
128
| MCP Server (Streamable HTTP) |**Implemented**|`mcp_http.py`|
129
129
| FC deployment artifact application |**Implemented**|`agent_sandbox.agent.mcp_http:asgi_app`; the artifact is generated by `abx mcp deploy` in the CLI. See [mcp-server.md](design/mcp-server.md#7-fc-deployment)|
130
130
| Template build/push/deploy |**In the CLI**|`abx template build` and `abx template deploy`; the SDK does not build templates |
| One environment variable per configuration key (SDK) |**Implemented**| See [Configuration](reference/configuration.md); CLI spec in `cli/docs/design/providers-and-credentials-cli.md`|
133
132
| Provider plugins (SDK, `python -m agent_sandbox.providers`) |**Implemented**| See [Providers](guide/providers.md). The CLI loads installed `node`, `exec` and `rest` plugins (`abx provider`, `abx --provider`) |
134
133
| Persistent sandbox |**Future**| Requires underlying platform support |
Copy file name to clipboardExpand all lines: docs/en/design/architecture.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -260,7 +260,7 @@ The CLI (`abx`) formerly lived in `src/agent_sandbox/cli/` (Click commands under
260
260
261
261
## 6. Design Principles
262
262
263
-
1.**E2B-shaped, not E2B-compatible**: L3 uses E2B-shaped method names and ships a small migration helper (`agent_sandbox.compat`); L2 implements the protocol independently without depending on the E2B SDK
263
+
1.**Explicit standard and provider contracts**: L3 uses E2B-shaped method names through the maintained standard clients; native provider extensions use ProviderSandbox without depending on the E2B SDK
264
264
2.**Progressive Complexity**: Users start at L3 and explore downward or use advanced features upward as needed
265
265
3.**Zero-Config Defaults**: Works out of the box with sensible defaults; just set the `ABX_SANDBOX_API_KEY` environment variable to get started
266
266
4.**Alibaba Cloud Native**: Built for the Alibaba Cloud FC sandbox service
@@ -269,6 +269,6 @@ The CLI (`abx`) formerly lived in `src/agent_sandbox/cli/` (Click commands under
Provider configuration discovery is assembled lazily by the package composition root. Transport consumes a low-level `ProviderSchema` value and an injected resolver from `_provider_schema.py`; it does not import the provider registry. Builtin configuration resolves without provider discovery. Registered, entry-point and installed providers retain the registry selection and derive/default/inheritance rules. The existing `transport.config.ProviderSchema` import remains an alias of the same schema class.
272
+
Provider configuration discovery is assembled lazily by the package composition root. Transport consumes a low-level `ProviderSchema` value and an injected resolver from `_provider_schema.py`; it does not import the provider registry. Builtin configuration resolves without provider discovery. Registered, entry-point and installed providers retain the registry selection and derive/default/inheritance rules.
273
273
274
-
Builtin platform/envd HTTP uses one transport attempt. Legacy retry fields are compatibility data, with the exact boundary in [configuration](../reference/configuration.md#legacy-retry-compatibility); engine recovery remains separate.
274
+
Builtin platform/envd HTTP uses one transport attempt; see [configuration](../reference/configuration.md#transport-attempts). Engine read recovery remains separate.
Copy file name to clipboardExpand all lines: docs/en/design/client-server-alignment.md
+2-4Lines changed: 2 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,8 +51,6 @@ one-sided (section 4).
51
51
|`GET /files/download-stream`|`files_download_stream`|`files.read/download`|`server.files.download(path)`, `.read_text`, `.download_file`| NEW |
52
52
|`POST /files/archive`|`files_archive`| — |`server.files.archive(paths, format)`| NEW |
53
53
|`GET /files/watch`|`files_watch`|`files.watch` (WatchDir) |`server.files.watch(path)` -> async iterator of `ServerWatchEvent` (a `WatchEvent` subclass with `is_dir`) | NEW server + client |
0 commit comments