agentscope-service-sdk 2.1.0b1__tar.gz

agentscope_service_sdk-2.1.0b1/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

agentscope_service_sdk-2.1.0b1/PKG-INFO

@@ -0,0 +1,253 @@
+Metadata-Version: 2.4
+Name: agentscope-service-sdk
+Version: 2.1.0b1
+Summary: AgentScope Service SDK: connect agent frameworks and report to the Control Plane
+License: 
+                                         Apache License
+                                   Version 2.0, January 2004
+                                http://www.apache.org/licenses/
+        
+           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+        
+           1. Definitions.
+        
+              "License" shall mean the terms and conditions for use, reproduction,
+              and distribution as defined by Sections 1 through 9 of this document.
+        
+              "Licensor" shall mean the copyright owner or entity authorized by
+              the copyright owner that is granting the License.
+        
+              "Legal Entity" shall mean the union of the acting entity and all
+              other entities that control, are controlled by, or are under common
+              control with that entity. For the purposes of this definition,
+              "control" means (i) the power, direct or indirect, to cause the
+              direction or management of such entity, whether by contract or
+              otherwise, or (ii) ownership of fifty percent (50%) or more of the
+              outstanding shares, or (iii) beneficial ownership of such entity.
+        
+              "You" (or "Your") shall mean an individual or Legal Entity
+              exercising permissions granted by this License.
+        
+              "Source" form shall mean the preferred form for making modifications,
+              including but not limited to software source code, documentation
+              source, and configuration files.
+        
+              "Object" form shall mean any form resulting from mechanical
+              transformation or translation of a Source form, including but
+              not limited to compiled object code, generated documentation,
+              and conversions to other media types.
+        
+              "Work" shall mean the work of authorship, whether in Source or
+              Object form, made available under the License, as indicated by a
+              copyright notice that is included in or attached to the work
+              (an example is provided in the Appendix below).
+        
+              "Derivative Works" shall mean any work, whether in Source or Object
+              form, that is based on (or derived from) the Work and for which the
+              editorial revisions, annotations, elaborations, or other modifications
+              represent, as a whole, an original work of authorship. For the purposes
+              of this License, Derivative Works shall not include works that remain
+              separable from, or merely link (or bind by name) to the interfaces of,
+              the Work and Derivative Works thereof.
+        
+              "Contribution" shall mean any work of authorship, including
+              the original version of the Work and any modifications or additions
+              to that Work or Derivative Works thereof, that is intentionally
+              submitted to Licensor for inclusion in the Work by the copyright owner
+              or by an individual or Legal Entity authorized to submit on behalf of
+              the copyright owner. For the purposes of this definition, "submitted"
+              means any form of electronic, verbal, or written communication sent
+              to the Licensor or its representatives, including but not limited to
+              communication on electronic mailing lists, source code control systems,
+              and issue tracking systems that are managed by, or on behalf of, the
+              Licensor for the purpose of discussing and improving the Work, but
+              excluding communication that is conspicuously marked or otherwise
+              designated in writing by the copyright owner as "Not a Contribution."
+        
+              "Contributor" shall mean Licensor and any individual or Legal Entity
+              on behalf of whom a Contribution has been received by Licensor and
+              subsequently incorporated within the Work.
+        
+           2. Grant of Copyright License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              copyright license to reproduce, prepare Derivative Works of,
+              publicly display, publicly perform, sublicense, and distribute the
+              Work and such Derivative Works in Source or Object form.
+        
+           3. Grant of Patent License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              (except as stated in this section) patent license to make, have made,
+              use, offer to sell, sell, import, and otherwise transfer the Work,
+              where such license applies only to those patent claims licensable
+              by such Contributor that are necessarily infringed by their
+              Contribution(s) alone or by combination of their Contribution(s)
+              with the Work to which such Contribution(s) was submitted. If You
+              institute patent litigation against any entity (including a
+              cross-claim or counterclaim in a lawsuit) alleging that the Work
+              or a Contribution incorporated within the Work constitutes direct
+              or contributory patent infringement, then any patent licenses
+              granted to You under this License for that Work shall terminate
+              as of the date such litigation is filed.
+        
+           4. Redistribution. You may reproduce and distribute copies of the
+              Work or Derivative Works thereof in any medium, with or without
+              modifications, and in Source or Object form, provided that You
+              meet the following conditions:
+        
+              (a) You must give any other recipients of the Work or
+                  Derivative Works a copy of this License; and
+        
+              (b) You must cause any modified files to carry prominent notices
+                  stating that You changed the files; and
+        
+              (c) You must retain, in the Source form of any Derivative Works
+                  that You distribute, all copyright, patent, trademark, and
+                  attribution notices from the Source form of the Work,
+                  excluding those notices that do not pertain to any part of
+                  the Derivative Works; and
+        
+              (d) If the Work includes a "NOTICE" text file as part of its
+                  distribution, then any Derivative Works that You distribute must
+                  include a readable copy of the attribution notices contained
+                  within such NOTICE file, excluding those notices that do not
+                  pertain to any part of the Derivative Works, in at least one
+                  of the following places: within a NOTICE text file distributed
+                  as part of the Derivative Works; within the Source form or
+                  documentation, if provided along with the Derivative Works; or,
+                  within a display generated by the Derivative Works, if and
+                  wherever such third-party notices normally appear. The contents
+                  of the NOTICE file are for informational purposes only and
+                  do not modify the License. You may add Your own attribution
+                  notices within Derivative Works that You distribute, alongside
+                  or as an addendum to the NOTICE text from the Work, provided
+                  that such additional attribution notices cannot be construed
+                  as modifying the License.
+        
+              You may add Your own copyright statement to Your modifications and
+              may provide additional or different license terms and conditions
+              for use, reproduction, or distribution of Your modifications, or
+              for any such Derivative Works as a whole, provided Your use,
+              reproduction, and distribution of the Work otherwise complies with
+              the conditions stated in this License.
+        
+           5. Submission of Contributions. Unless You explicitly state otherwise,
+              any Contribution intentionally submitted for inclusion in the Work
+              by You to the Licensor shall be under the terms and conditions of
+              this License, without any additional terms or conditions.
+              Notwithstanding the above, nothing herein shall supersede or modify
+              the terms of any separate license agreement you may have executed
+              with Licensor regarding such Contributions.
+        
+           6. Trademarks. This License does not grant permission to use the trade
+              names, trademarks, service marks, or product names of the Licensor,
+              except as required for reasonable and customary use in describing the
+              origin of the Work and reproducing the content of the NOTICE file.
+        
+           7. Disclaimer of Warranty. Unless required by applicable law or
+              agreed to in writing, Licensor provides the Work (and each
+              Contributor provides its Contributions) on an "AS IS" BASIS,
+              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+              implied, including, without limitation, any warranties or conditions
+              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+              PARTICULAR PURPOSE. You are solely responsible for determining the
+              appropriateness of using or redistributing the Work and assume any
+              risks associated with Your exercise of permissions under this License.
+        
+           8. Limitation of Liability. In no event and under no legal theory,
+              whether in tort (including negligence), contract, or otherwise,
+              unless required by applicable law (such as deliberate and grossly
+              negligent acts) or agreed to in writing, shall any Contributor be
+              liable to You for damages, including any direct, indirect, special,
+              incidental, or consequential damages of any character arising as a
+              result of this License or out of the use or inability to use the
+              Work (including but not limited to damages for loss of goodwill,
+              work stoppage, computer failure or malfunction, or any and all
+              other commercial damages or losses), even if such Contributor
+              has been advised of the possibility of such damages.
+        
+           9. Accepting Warranty or Additional Liability. While redistributing
+              the Work or Derivative Works thereof, You may choose to offer,
+              and charge a fee for, acceptance of support, warranty, indemnity,
+              or other liability obligations and/or rights consistent with this
+              License. However, in accepting such obligations, You may act only
+              on Your own behalf and on Your sole responsibility, not on behalf
+              of any other Contributor, and only if You agree to indemnify,
+              defend, and hold each Contributor harmless for any liability
+              incurred by, or claims asserted against, such Contributor by reason
+              of your accepting any such warranty or additional liability.
+        
+           END OF TERMS AND CONDITIONS
+        
+           APPENDIX: How to apply the Apache License to your work.
+        
+              To apply the Apache License to your work, attach the following
+              boilerplate notice, with the fields enclosed by brackets "[]"
+              replaced with your own identifying information. (Don't include
+              the brackets!)  The text should be enclosed in the appropriate
+              comment syntax for the file format. We also recommend that a
+              file or class name and description of purpose be included on the
+              same "printed page" as the copyright notice for easier
+              identification within third-party archives.
+        
+           Copyright [yyyy] [name of copyright owner]
+        
+           Licensed under the Apache License, Version 2.0 (the "License");
+           you may not use this file except in compliance with the License.
+           You may obtain a copy of the License at
+        
+               http://www.apache.org/licenses/LICENSE-2.0
+        
+           Unless required by applicable law or agreed to in writing, software
+           distributed under the License is distributed on an "AS IS" BASIS,
+           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+           See the License for the specific language governing permissions and
+           limitations under the License.
+        
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: grpcio>=1.80
+Requires-Dist: protobuf<7,>=6.31.1
+Provides-Extra: openclaw
+Requires-Dist: websockets>=12; extra == "openclaw"
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23; extra == "dev"
+Requires-Dist: grpcio-tools==1.80.0; extra == "dev"
+Dynamic: license-file
+
+# Control Plane Python SDK
+
+Integration SDK for AgentScope Service: framework observation, session events, application contracts and collaboration clients.
+
+Install the `agentscope-service-sdk` version listed in the Service release manifest, or install a downloaded wheel:
+
+```bash
+python -m pip install ./agentscope_service_sdk-VERSION-py3-none-any.whl
+```
+
+Python 3.9+ is required by the package metadata. grpcio and protobuf constraints are declared in `pyproject.toml`. Optional OpenClaw WebSocket support is available through `agentscope-service-sdk[openclaw]`.
+
+## Choose a transport before connecting
+
+Standard Service deployments support outbound HTTP execution: `instrument(..., control_plane_http=base, transport="http")`. The worker registers using its bootstrap credential, then uses its scoped registration credential at `/api/v1/agent-runtime/exchange`. Commands are acknowledged after acceptance; event batches retain their durable journal until the separate event ACK. No inbound worker port is needed; set `start_http=False` when the optional observation contract server is not used.
+
+`transport="grpc"` selects ASDP for deployments with a reachable gRPC listener; pass `control_plane="host:port"`. The legacy parameter name `start_grpc=False` disables either selected push transport and its advertised execution/reporting capabilities. It is only useful for standalone observation. Do not use an HTTP port as a gRPC address.
+
+`ServiceClient` provides snapshot, paginated events, SSE, capabilities, commands, actions, usage, artifacts and webhooks. `ManagementClient` provides Applications, Agents, Teams, Workflow definitions, runtime policies and application credentials. Management uses a platform token; invocation uses an application API key or an authorized platform token. API keys require an Application, explicit target grants, and scopes. Use `create_session(target)` followed by `submit(session_id, ..., idempotency_key=...)` for Agents, Teams, and Workflows.
+
+See `../../examples/service-api/README.md` for a complete API-only bootstrap and reconnect/approval flow. `AsyncInvokeAdapter` and `AgentScopeRunnerAdapter` execute fresh framework instances with explicit input mapping. Automatic framework detection selects observation adapters, not execution runners.
+
+## Develop
+
+```bash
+python -m pip install -e '.[dev]'
+python -m pytest
+python -m build
+```
+
+Licensed under Apache-2.0; see `LICENSE`.
+
+Event journal records are limited to 16 MiB. HTTP batches target 16 MiB and requests allow 32 MiB; gRPC messages allow 32 MiB. Oversized execution events raise explicitly rather than truncating. Store large tool output as an artifact and emit its reference.

agentscope_service_sdk-2.1.0b1/README.md

@@ -0,0 +1,33 @@
+# Control Plane Python SDK
+
+Integration SDK for AgentScope Service: framework observation, session events, application contracts and collaboration clients.
+
+Install the `agentscope-service-sdk` version listed in the Service release manifest, or install a downloaded wheel:
+
+```bash
+python -m pip install ./agentscope_service_sdk-VERSION-py3-none-any.whl
+```
+
+Python 3.9+ is required by the package metadata. grpcio and protobuf constraints are declared in `pyproject.toml`. Optional OpenClaw WebSocket support is available through `agentscope-service-sdk[openclaw]`.
+
+## Choose a transport before connecting
+
+Standard Service deployments support outbound HTTP execution: `instrument(..., control_plane_http=base, transport="http")`. The worker registers using its bootstrap credential, then uses its scoped registration credential at `/api/v1/agent-runtime/exchange`. Commands are acknowledged after acceptance; event batches retain their durable journal until the separate event ACK. No inbound worker port is needed; set `start_http=False` when the optional observation contract server is not used.
+
+`transport="grpc"` selects ASDP for deployments with a reachable gRPC listener; pass `control_plane="host:port"`. The legacy parameter name `start_grpc=False` disables either selected push transport and its advertised execution/reporting capabilities. It is only useful for standalone observation. Do not use an HTTP port as a gRPC address.
+
+`ServiceClient` provides snapshot, paginated events, SSE, capabilities, commands, actions, usage, artifacts and webhooks. `ManagementClient` provides Applications, Agents, Teams, Workflow definitions, runtime policies and application credentials. Management uses a platform token; invocation uses an application API key or an authorized platform token. API keys require an Application, explicit target grants, and scopes. Use `create_session(target)` followed by `submit(session_id, ..., idempotency_key=...)` for Agents, Teams, and Workflows.
+
+See `../../examples/service-api/README.md` for a complete API-only bootstrap and reconnect/approval flow. `AsyncInvokeAdapter` and `AgentScopeRunnerAdapter` execute fresh framework instances with explicit input mapping. Automatic framework detection selects observation adapters, not execution runners.
+
+## Develop
+
+```bash
+python -m pip install -e '.[dev]'
+python -m pytest
+python -m build
+```
+
+Licensed under Apache-2.0; see `LICENSE`.
+
+Event journal records are limited to 16 MiB. HTTP batches target 16 MiB and requests allow 32 MiB; gRPC messages allow 32 MiB. Oversized execution events raise explicitly rather than truncating. Store large tool output as an artifact and emit its reference.

agentscope_service_sdk-2.1.0b1/agentscope_service/__init__.py

@@ -0,0 +1,181 @@
+# Copyright 2024-2026 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""AgentScope Service Python SDK — 异构 Agent 框架的数据面适配层。
+
+旁路拦截各框架 Session / Context / Subagent / Workspace 数据，经混合通道
+（ASDP gRPC 上行推送 + 内嵌 HTTP 合约服务）送到 Control Plane 控制面。
+
+用户入口（sdk-design §5.4）::
+
+    import agentscope_service
+    from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions
+
+    client = ClaudeSDKClient(ClaudeAgentOptions(...))
+    agentscope_service.instrument(
+        client,
+        control_plane="service-controlplane.controlplane-system:9090",
+        control_plane_http="http://service-controlplane.controlplane-system:8080",
+        agent_key="my-claude-agent",
+        namespace="default",
+        enable_events=True,       # 持久化事件是会话历史的默认事实源
+        contract_http_port=8080,
+    )
+"""
+from __future__ import annotations
+
+import os
+import socket
+from typing import Any, Optional
+
+__version__ = "2.1.0b1"
+
+from .adapters.base import FrameworkAdapter
+from .adapters.registry import find_adapter, register_adapter, registered_adapters
+from .bridge import SessionBridge
+from .collaboration import CollaborationClient, CollaborationError
+from .context import ContextMessage, ContextSnapshot, ContextTracker, ToolInfo
+from .events import (
+    EVENT_COMPACTION,
+    EVENT_MESSAGE,
+    EVENT_SESSION_END,
+    EVENT_SESSION_START,
+    EVENT_TOOL_CALL,
+    EVENT_TOOL_RESULT,
+    MessageItem,
+    MessagePage,
+    SessionEvent,
+)
+from .inventory import InstanceHealth, Inventory, SubagentInfo, WorkspaceInfo
+from .orchestration import OrchestrationClient, OrchestrationError
+
+
+def instrument(
+    target: Any,
+    *,
+    control_plane: str = "",
+    agent_key: str,
+    tenant: str = "default",
+    internal_token: Optional[str] = None,
+    registration_credential: Optional[str] = None,
+    control_plane_http: str = "",
+    agent_id: str = "",
+    binding_id: str = "",
+    namespace: str = "default",
+    instance_key: Optional[str] = None,
+    generation: int = 0,
+    enable_events: bool = True,
+    event_journal_dir: str = "",
+    contract_http_port: int = 8080,
+    contract_http_base_url: str = "",
+    session_affinity: str = "",
+    start_http: bool = True,
+    start_grpc: bool = True,
+    transport: str = "http",
+    adapter: Optional[FrameworkAdapter] = None,
+) -> SessionBridge:
+    """一行代码接入任何框架（framework-integration §3.1 / sdk-design §5.4）。
+
+    自动识别框架类型并挂载匹配的 ``FrameworkAdapter``；返回已启动的
+    ``SessionBridge``（可作上下文管理器，``with ... as bridge:``）。
+
+    ``instance_key`` 缺省取 ``HOSTNAME`` 环境变量（K8s Downward API 注入的
+    Pod 名），再缺省取主机名。
+
+    传入 ``control_plane_http`` 时，SDK 会先通过 v5 注册接口获得稳定的
+    ``agentId/bindingId/generation`` 和 registration credential，再建立 ASDP。
+    已持久化这些值的实例也可直接传入，跳过首次注册。
+    """
+    if adapter is None:
+        adapter = find_adapter(target)
+        if adapter is None:
+            raise ValueError(f"unsupported framework: {type(target).__name__}")
+    if not instance_key:
+        instance_key = os.environ.get("HOSTNAME") or socket.gethostname()
+    if internal_token is None:
+        internal_token = os.environ.get("CONTROL_PLANE_INTERNAL_TOKEN", "")
+    if registration_credential is None:
+        registration_credential = os.environ.get("CONTROL_PLANE_REGISTRATION_CREDENTIAL", "")
+    bridge = SessionBridge(
+        control_plane=control_plane,
+        control_plane_http=control_plane_http,
+        agent_key=agent_key,
+        tenant=tenant,
+        internal_token=internal_token,
+        registration_credential=registration_credential,
+        agent_id=agent_id,
+        binding_id=binding_id,
+        namespace=namespace,
+        instance_key=instance_key,
+        generation=generation,
+        enable_events=enable_events,
+        event_journal_dir=event_journal_dir,
+        contract_http_port=contract_http_port,
+        contract_http_base_url=contract_http_base_url,
+        session_affinity=session_affinity,
+        start_http=start_http,
+        start_grpc=start_grpc,
+        transport=transport,
+    )
+    bridge.attach_target(target, adapter=adapter)
+    bridge.start()
+    return bridge
+
+
+__all__ = [
+    "__version__",
+    # 入口
+    "instrument",
+    "SessionBridge",
+	"CollaborationClient",
+	"CollaborationError",
+	"OrchestrationClient",
+	"OrchestrationError",
+    "FrameworkAdapter",
+    "register_adapter",
+    "registered_adapters",
+    "find_adapter",
+    # events
+    "SessionEvent",
+    "MessageItem",
+    "MessagePage",
+    "EVENT_SESSION_START",
+    "EVENT_MESSAGE",
+    "EVENT_TOOL_CALL",
+    "EVENT_TOOL_RESULT",
+    "EVENT_SESSION_END",
+    "EVENT_COMPACTION",
+    # context
+    "ContextMessage",
+    "ContextSnapshot",
+    "ContextTracker",
+    "ToolInfo",
+    # inventory
+    "SubagentInfo",
+    "WorkspaceInfo",
+    "InstanceHealth",
+    "Inventory",
+]
+
+from .adapters.executable import ExecutableAdapter, TaskContext, TaskResult
+from .service import ServiceClient
+__all__ += ["ExecutableAdapter", "TaskContext", "TaskResult", "ServiceClient"]
+
+from .adapters.runners import AgentScopeRunnerAdapter, AsyncInvokeAdapter
+
+__all__ += ["AgentScopeRunnerAdapter", "AsyncInvokeAdapter"]
+
+from .management import ManagementClient
+
+__all__ += ["ManagementClient"]