Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 30 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,21 @@ hashes. Do not automatically sync or delete the original repository's Core.
Core orchestrates protocol-defined operations. Sandbox providers, Runtime
implementations, harnesses and model providers are replaceable components.
User-owned machines, E2B, Docker and other environments must expose the same
execution protocol; placement and connection details belong to their providers.
execution protocol. Resource management selects machines, allocates capacity and
creates, renews and reclaims Environments; Runtime prepares capabilities, executes
work and recovers within an Environment. Keep these contracts and lifetimes
separate: closing a Session executor does not release its allocation, destroy its
Environment or delete its workspace. Reclamation is an explicit resource-manager
operation coordinated with active work.

The capability-unification target is one Runtime preparation path for managed
bundles and self-hosted local directories. Core resolves configuration, versions
and resources; Runtime uses one parser and `installed.json` snapshot to supply
Skill paths and MCP declarations to adapters. Preparation must complete before
execution; reconnect reuses installed contents, and new Sessions freeze a new
configuration snapshot. The protocol is platform-neutral, while the first
implementation is Linux-only. This is pending work, not a statement that current
managed and self-hosted preparation or Windows/macOS isolation is already unified.

- Keep component boundaries explicit through shared interfaces and versioned
protocols. Register implementations behind those interfaces. Adding an
Expand Down Expand Up @@ -84,8 +98,10 @@ removed; only the historical `source:"admin_copy"` provenance read remains, fed
or request bodies enter logs. The console's fixed actor label (`console`) is only
an audit display label, never an authorization input.

When requirements conflict, object ownership is unclear, or a design would need
parallel compatibility paths, raise the issue with a concrete recommendation and
Apply the latest explicit user decisions when older documents conflict, and
update the affected current guidance. Historical evidence does not override those
decisions. When requirements remain unresolved, object ownership is unclear, or a
design would need parallel compatibility paths, raise the issue with a concrete recommendation and
tradeoffs before implementing the disputed behavior. Continue independent work
while the decision is pending. Do not silently preserve obsolete private designs.

Expand Down Expand Up @@ -2211,9 +2227,11 @@ TLS reverse proxy routes `/v1` (applications) and `/api/v1` (nodes and Runtime
daemons, with their own credentials) directly to Core and everything else,
including `/core/v1`, to Web. Operator scripts call `/core/v1` on Core's loopback
port.
Nodes and Core come from one distribution; older nodes using the removed
`/core/v1/sandbox` node paths cannot connect and are replaced through the drained
upgrade and re-enrollment workflow.
Nodes and Core come from one distribution. Older nodes using the removed
`/core/v1/sandbox` paths are unsupported; preserve their installation and data and
use a separate fresh installation. There is no drained in-place upgrade or
historical re-enrollment procedure. Current-version Runtime generation rollout
retains its separate resource lifecycle.

The Web manager offers no manual Core key entry outside sign-in, and Web refuses
to start without its Core key file. It holds no Project API key and never calls
Expand Down Expand Up @@ -3119,16 +3137,15 @@ replaced; do not carry obsolete compatibility code forward to satisfy this secti
Item's Session position under the Session lock, preserving observation order
for equal timestamps. Allocate a separate zero-based `output_index` per Turn;
inputs do not consume output indexes. Updates and retries retain both values.
Existing indexed history keeps its pre-upgrade deterministic order; missing
original ordering cannot be reconstructed. Cursors are scoped to the authenticated Session.
Persisted indexed history keeps its deterministic order; missing original
ordering cannot be reconstructed. Cursors are scoped to the authenticated Session.
Terminal Turns expose unfinished Items as `incomplete`, preserving completed
message/tool states independently of the Turn outcome.
- Public history reads use the persisted index; the private pre-Items journal
backfill is retired. Migration 15 rejects unprepared historical Turns before
removing the obsolete indexing marker. Prepare them with release `906069e`
before upgrading, following `services/agents-api/README.md`. The migration
preserves indexed Item payloads, positions, output indexes and source journals;
never mark unprepared history indexed by hand or replay engine execution.
backfill is retired. Migration 15 and its historical validation remain evidence,
not a supported upgrade procedure. An old installation is unsupported and must
be retained separately from a fresh installation. Never mark unprepared history
indexed by hand or replay engine execution to convert it.
- Project only the declared public Item variants; native adapter metadata is not
a response schema. Preserve structured tool JSON without float conversion.
Completion text replaces accumulated deltas. Item merging must not mutate the
Expand Down
36 changes: 20 additions & 16 deletions apps/docs/FOLLOW-UP.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,27 @@
# Feature integration follow-up
# Documentation integration status

This candidate documents durable reset, retained Core generations and verified
same-team E2B online changes at source `b9b13b186089b317db271ab83b10f86b48168f66`.
Node changes still require zero held resources until the node protocol is complete.
The Core error-envelope foundation is included; later configuration validators and
diagnostic endpoints are not. Do not replace current procedures with planned behavior
before those features land.
The current repository implements durable reset, retained deployment generations,
same-team E2B online changes and Docker/microsandbox online size and Runtime targets
(design 50, including #178). Node target preparation, qualified serving generations,
retained ownership and generation GC coexist; target changes require neither an
execution drain nor node reenrollment. Core error details, configuration validators
and Session diagnostics are also present in the current source.

| Feature dependency | Site pages to reconcile | Source and verification work |
| --- | --- | --- |
| Final Web generation controls (design 50 PR-W) | configure, hosted-providers, troubleshooting, execution-model | Reconcile the actual Web workflow after node online changes are qualified; keep target preparation separate from serving readiness. |
| Node update protocol (design 50 PR-N) | hosted-providers, troubleshooting, API reference/machine | Explain the implemented update command, old-node handling and ownership preservation. Do not claim an update command now. |
| Later configuration/error changes (design 40 and remaining installer work) | install, configure, troubleshooting, quickstart | Regenerate current configuration fields and revise diagnostics against merged code; keep secrets out of examples. |
| Final feature assembly | every Chinese reading note, execution-model diagram, all generated references | Review translations against regenerated English, verify source provenance and links, run contract/route/copy/fact checks, typecheck/build, local browser review and the repository gate. |
These are repository implementation facts, not evidence that a release was published
or deployed. Use the merged source revision and its matching bundle for an installed
release. A proposal or an unmerged implementation must stay labelled as such until
integration and the requested acceptance have completed.

| Remaining requirement | Documentation boundary |
| --- | --- |
| Unified Runtime capability preparation | Future design: keep resource allocation, Environment creation and reclamation separate from Runtime prepare/execute/recover. Closing an executor must not destroy its Environment, delete its workspace or release its allocation. Define a platform-neutral protocol with Linux as the first implementation; do not claim it exists today. |
| Agent metrics backend aggregation (BE8) | Still a proposal. Current browser fan-out is not a deployment-wide backend aggregation service; preserve coverage and missing-data limits. |
| Release qualification and publication | Reconcile the final merged source, generated references and reading notes, and record the requested checks. Source implementation alone does not establish published-release or live-deployment readiness. |

English guides are rendered from repository sources. Chinese pages are explicitly
labelled reading notes, not complete translations; expand them only against the final
source procedures. API tag pages use the default-language fallback. Release publication,
remote deployment and preview replacement are outside this reconciliation task.
labelled reading notes, not complete translations. Review them when the canonical
procedures change. API tag pages use the default-language fallback. Remote deployment
and preview replacement are outside this documentation reconciliation.

The source Web guide still carries a pre-rename screenshot. This site copies the
approved current Web onboarding Monitor image instead, with its own source hash;
Expand Down
6 changes: 3 additions & 3 deletions apps/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,6 @@ Set `DOCS_SITE_ORIGIN` only when preparing actual publication.
Generation links to the recorded source revision; update that revision after rebasing
onto later canonical guide changes. Never point samples at an actual deployment by default.

[Feature follow-up inventory](FOLLOW-UP.md) lists the reset and online-generation
paragraphs that must be reconciled after those implementations land. This candidate
cannot establish final documentation acceptance for those unfinished features.
[Documentation integration status](FOLLOW-UP.md) distinguishes implemented Runtime
generation behavior from future requirements and release qualification. Regenerated
source pages do not by themselves establish that a release is published or deployed.
24 changes: 12 additions & 12 deletions apps/docs/content/docs/admin-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ resource inspection, Project and key management, credential issuance, audit, usa
and sandbox operations. It never calls `/v1` or `/api/v1`, and has no Agent
execution, copy or arbitrary asset editing operation.

Core request failures use the [Core administration error envelope](https://github.com/MiniMax-AI/parsar-core/blob/f36ac3592bfe9f77a2172680aa52b14c6f525062/contracts/agents-api/core-errors.md),
Core request failures use the [Core administration error envelope](https://github.com/MiniMax-AI/parsar-core/blob/cd6a32c3de31d26b73ab92d21ba2aa7b067ba226/contracts/agents-api/core-errors.md),
including optional typed safe details. Console sign-in endpoints retain their
separate error shape described below.

Expand Down Expand Up @@ -49,9 +49,9 @@ label, but could set any value. Never use it for authorization or as proof of
origin.

Web calls Core only through the typed Core clients in `packages/agents-client`:
[AdminClient](https://github.com/MiniMax-AI/parsar-core/blob/f36ac3592bfe9f77a2172680aa52b14c6f525062/packages/agents-client/src/admin-client.ts) (`/core/v1`),
[AdminClient](https://github.com/MiniMax-AI/parsar-core/blob/cd6a32c3de31d26b73ab92d21ba2aa7b067ba226/packages/agents-client/src/admin-client.ts) (`/core/v1`),
`SandboxAdminClient` (`/core/v1/sandbox`) and `CoreMetricsClient`
(`/core/v1/metrics`). See [the complete administrator reference](https://github.com/MiniMax-AI/parsar-core/blob/f36ac3592bfe9f77a2172680aa52b14c6f525062/contracts/agents-api/admin-api.md)
(`/core/v1/metrics`). See [the complete administrator reference](https://github.com/MiniMax-AI/parsar-core/blob/cd6a32c3de31d26b73ab92d21ba2aa7b067ba226/contracts/agents-api/admin-api.md)
for methods, fields, filters, pagination and response shapes.
Routes below are relative to `/core/v1`:

Expand All @@ -62,8 +62,8 @@ Routes below are relative to `/core/v1`:
| Resource lists/details/deletion | `/projects/{id}/agents`, `/sessions`, `/environment-templates`, `/skills`, `/files`, `/vaults`, including the documented nested reads |
| Asset ownership | `GET /projects/{id}/resource-owners` with batched resource IDs |
| Key operation history | `GET /projects/{id}/write-operations` with key/resource/time filters |
| Executor credentials | `GET/POST /projects/{id}/environments/{environment_id}/executor-credentials`, `DELETE …/executor-credentials/{key_id}` ([contract](https://github.com/MiniMax-AI/parsar-core/blob/f36ac3592bfe9f77a2172680aa52b14c6f525062/contracts/agents-api/environment-executor-credentials.md)) |
| Deployment model providers | `GET /harnesses`, `GET/PUT/DELETE /harnesses/{harness}/model-provider`; the key is write-only ([contract](https://github.com/MiniMax-AI/parsar-core/blob/f36ac3592bfe9f77a2172680aa52b14c6f525062/contracts/agents-api/model-execution.md#deployment-defaults)) |
| Executor credentials | `GET/POST /projects/{id}/environments/{environment_id}/executor-credentials`, `DELETE …/executor-credentials/{key_id}` ([contract](https://github.com/MiniMax-AI/parsar-core/blob/cd6a32c3de31d26b73ab92d21ba2aa7b067ba226/contracts/agents-api/environment-executor-credentials.md)) |
| Deployment model providers | `GET /harnesses`, `GET/PUT/DELETE /harnesses/{harness}/model-provider`; the key is write-only ([contract](https://github.com/MiniMax-AI/parsar-core/blob/cd6a32c3de31d26b73ab92d21ba2aa7b067ba226/contracts/agents-api/model-execution.md#deployment-defaults)) |
| Usage and health | `GET /summary`, `/sandbox/runtime-observations`, `/metrics` |
| Administrator audit | `GET /audit-log`; deployment-wide entries have `project_id: null` |

Expand All @@ -76,9 +76,9 @@ it is operational attribution, not per-key billing.

## Sandbox administration

The [deployment configuration contract](https://github.com/MiniMax-AI/parsar-core/blob/f36ac3592bfe9f77a2172680aa52b14c6f525062/contracts/agents-api/sandbox-deployment.md),
[nodes and sandbox backends reference](https://github.com/MiniMax-AI/parsar-core/blob/f36ac3592bfe9f77a2172680aa52b14c6f525062/services/agents-api/HOSTED-SANDBOX-MANAGER.md)
and [generated OpenAPI](https://github.com/MiniMax-AI/parsar-core/blob/f36ac3592bfe9f77a2172680aa52b14c6f525062/contracts/agents-api/core.openapi.yaml)
The [deployment configuration contract](https://github.com/MiniMax-AI/parsar-core/blob/cd6a32c3de31d26b73ab92d21ba2aa7b067ba226/contracts/agents-api/sandbox-deployment.md),
[nodes and sandbox backends reference](https://github.com/MiniMax-AI/parsar-core/blob/cd6a32c3de31d26b73ab92d21ba2aa7b067ba226/services/agents-api/HOSTED-SANDBOX-MANAGER.md)
and [generated OpenAPI](https://github.com/MiniMax-AI/parsar-core/blob/cd6a32c3de31d26b73ab92d21ba2aa7b067ba226/contracts/agents-api/core.openapi.yaml)
define deployment and node operations:

- `GET/POST/PUT /core/v1/sandbox/deployment` and
Expand Down Expand Up @@ -115,7 +115,7 @@ is a durable serving pin, not proof of current connectivity. Target unknown, fai
or update-required state does not by itself invalidate confirmed old-generation
service; consume Core's connection/provider facts separately.

Administrators may [archive an individual hosted Session](https://github.com/MiniMax-AI/parsar-core/blob/f36ac3592bfe9f77a2172680aa52b14c6f525062/contracts/agents-api/admin-api.md#administrative-session-archive)
Administrators may [archive an individual hosted Session](https://github.com/MiniMax-AI/parsar-core/blob/cd6a32c3de31d26b73ab92d21ba2aa7b067ba226/contracts/agents-api/admin-api.md#administrative-session-archive)
at the current generation without reset. History and persisted Files/Artifacts
survive; unpersisted workspace is lost and the original Session cannot resume.
Cancel reset stops further archives, not cleanup already requested. After zero
Expand Down Expand Up @@ -156,7 +156,7 @@ generated schema; do not interpret every empty or failed read as an absent resou
`GET /core/v1/metrics?range=1h|6h|24h|7d` returns Core process, execution
queue/slots, PostgreSQL and background-job measurements. It requires the Core key,
rejects arbitrary query filters and never grants
Agent execution access. See the [exact measurement contract](https://github.com/MiniMax-AI/parsar-core/blob/f36ac3592bfe9f77a2172680aa52b14c6f525062/contracts/agents-api/core-metrics.md)
Agent execution access. See the [exact measurement contract](https://github.com/MiniMax-AI/parsar-core/blob/cd6a32c3de31d26b73ab92d21ba2aa7b067ba226/contracts/agents-api/core-metrics.md)
for complete buckets, null values, units and process-local retention. Frontend
implementation is maintained separately; this backend change does not modify
Agent metrics or the public Agent API.
Expand All @@ -165,7 +165,7 @@ Agent metrics or the public Agent API.

The Core key reads a node and its host history through
`GET /core/v1/sandbox/nodes/{node_id}?range=1h|6h|24h`. See the
[node host history contract](https://github.com/MiniMax-AI/parsar-core/blob/f36ac3592bfe9f77a2172680aa52b14c6f525062/contracts/agents-api/node-host-history.md)
[node host history contract](https://github.com/MiniMax-AI/parsar-core/blob/cd6a32c3de31d26b73ab92d21ba2aa7b067ba226/contracts/agents-api/node-host-history.md)
for nullable observations, freshness and aggregation. The node list is unchanged.

[Repository source](https://github.com/MiniMax-AI/parsar-core/blob/f36ac3592bfe9f77a2172680aa52b14c6f525062/docs/api/web-management.md)
[Repository source](https://github.com/MiniMax-AI/parsar-core/blob/cd6a32c3de31d26b73ab92d21ba2aa7b067ba226/docs/api/web-management.md)
Loading
Loading