open-agent-control-panel 0.1.0__tar.gz

open_agent_control_panel-0.1.0/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.

open_agent_control_panel-0.1.0/NOTICE

@@ -0,0 +1,13 @@
+Open Agent Control Panel
+Copyright 2026 The Open Agent Control Panel contributors
+
+This product implements the A2A Discover Protocol (ADP) Core v1. The protocol
+specification and its reference implementation are published by their authors
+under the Apache License, Version 2.0.
+
+This product talks to agents over the Agent2Agent (A2A) protocol, published at
+https://a2a-protocol.org. A2A is an independent specification; this project
+neither modifies nor redistributes it.
+
+This product includes software developed by third parties under the terms of
+the Apache License, Version 2.0. See the LICENSE file for the full license text.

open_agent_control_panel-0.1.0/PKG-INFO

@@ -0,0 +1,260 @@
+Metadata-Version: 2.4
+Name: open-agent-control-panel
+Version: 0.1.0
+Summary: A control panel for A2A agents: register, discover, submit tasks and follow them.
+License-Expression: Apache-2.0
+Keywords: a2a,agent,agent-registry,agent-discovery,control-panel,fastapi
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Web Environment
+Classifier: Framework :: FastAPI
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: fastapi>=0.110
+Requires-Dist: httpx>=0.27
+Requires-Dist: uvicorn>=0.27
+Provides-Extra: dev
+Requires-Dist: build>=1.0; extra == "dev"
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: twine>=5.0; extra == "dev"
+Dynamic: license-file
+
+# Open Agent Control Panel
+
+**A control panel for A2A agents.** Register them through the A2A Discover Protocol,
+see everyone who is online, submit tasks over A2A JSON-RPC, and follow those tasks —
+from one small FastAPI service with a dependency-free web UI.
+
+[![PyPI](https://img.shields.io/pypi/v/open-agent-control-panel.svg)](https://pypi.org/project/open-agent-control-panel/)
+[![Python](https://img.shields.io/badge/python-3.10%2B-blue)](https://www.python.org/)
+[![License](https://img.shields.io/badge/license-Apache--2.0-lightgrey)](LICENSE)
+[![Protocol](https://img.shields.io/badge/protocol-ADP%20Core%201.0.0-informational)](https://github.com/YY-Yifei/open-agent-control-panel)
+
+---
+
+## What it does
+
+The panel sits between *you* and a fleet of [A2A](https://a2a-protocol.org) agents. It plays
+three roles at once:
+
+| Role | Surface | What it gives you |
+|---|---|---|
+| **Registry** | `/.well-known/a2a-registry.json`, `/v1/agents` | Agents register themselves by AgentCard URL; the panel fetches, validates and probes the card |
+| **Control plane** | `/api/panel/*` + the bundled UI | Every registered agent, its card, its skills, and the tasks you sent it |
+| **A2A client** | `message/send`, `tasks/get`, `tasks/cancel` | Submit a task, watch it move, cancel it, continue the conversation |
+
+The registry half implements the **A2A Discover Protocol (ADP) Core v1** contract: five operations, four invariants, and the SSRF rules in §7. The panel half is
+deliberately outside that contract — protocol endpoints stay exactly the protocol.
+
+## Why a registry at all
+
+A2A defines how agents talk to each other, but not where to find them. ADP closes that gap
+with one claim and nothing more:
+
+> *I fetched this card from this URL at `lastOkAt`, and its digest is `cardHash`. I claim
+> nothing else.*
+
+No scores, no trust badges, no ranking, no proxying. Registration is not proof of ownership —
+it only proves that the URL served that card at that moment. The panel honours that: it
+never invents a "verified" flag, and it never changes a byte of a card.
+
+## Quick start
+
+```bash
+pip install open-agent-control-panel
+oacp serve
+```
+
+Open <http://127.0.0.1:8000>. Anyone can now register an agent:
+
+```bash
+curl -X POST http://127.0.0.1:8000/v1/agents \
+     -H 'content-type: application/json' \
+     -d '{"url":"https://agent.example.com/.well-known/agent-card.json"}'
+```
+
+The response is the stored record plus a one-time `manageToken`. Keep it if you want to
+unregister later — it is not rotated and cannot be recovered.
+
+Then open the agent in the UI, press **Send task**, and the panel calls the agent's A2A
+endpoint with `message/send`.
+
+## Try it locally
+
+A real registration needs a public HTTPS URL, because the registry fetches the card itself.
+For a laptop demo, the repository ships a tiny echo agent and a development mode:
+
+```bash
+# terminal 1 — a demo agent on http://127.0.0.1:9100
+pip install -e ".[dev]"
+python examples/echo_agent.py
+
+# terminal 2 — the panel, in development mode
+oacp serve --port 8000 --allow-insecure-cards --allow-private-agents
+
+# register the demo agent through the UI, or:
+curl -X POST http://127.0.0.1:8000/v1/agents \
+     -H 'content-type: application/json' \
+     -d '{"url":"http://127.0.0.1:9100/.well-known/agent-card.json"}'
+```
+
+`--allow-insecure-cards` accepts `http://` and private addresses for **card URLs**;
+`--allow-private-agents` lets the A2A client call private endpoints. Both are development
+switches: with either one on, the deployment is no longer ADP-compliant, and the panel says
+so in its own summary.
+
+## What the UI gives you
+
+* **Agents** — status (`ok` / `down`), failures, last successful probe, skills, tags, task counts;
+  a detail page with endpoints, the full card and a raw-JSON view.
+* **Tasks** — every task the panel submitted, filterable by state, with a live view of the
+  agent's latest output, the event log, and the raw request/response payloads.
+* **Actions** — register, re-fetch a card, send a task, follow up with another message,
+  refresh from the agent, cancel, unregister, forget.
+* **Zero build step** — the front end is three static files (`index.html`, `styles.css`,
+  `app.js`), served by the same process. No Node, no bundler, no CDN.
+
+## Protocol surface
+
+| Method | Path | Purpose |
+|---|---|---|
+| `GET` | `/.well-known/a2a-registry.json` | RegistryCard (name, apiBase, spec, probe interval, limits) |
+| `POST` | `/v1/agents` | `{"url": …}` → fetch, validate, store; `201` + one-time `manageToken` |
+| `GET` | `/v1/agents` | `?q=&skill=&tag=&status=&changedSince=&full=&limit=&cursor=` |
+| `GET` | `/v1/agents/{id}` | One AgentRecord, including the card |
+| `DELETE` | `/v1/agents/{id}` | Unregister; requires `X-ADP-Token` |
+
+Records follow the contract exactly: `id` is derived from the normalized URL, `cardHash` is
+`sha256(JCS(card))`, `checkedAt` moves on every attempt, `lastOkAt` only on success, and
+`changedAt`/`prevHash` are always present (nullable) so clients need one branch, not two.
+
+Panel endpoints (not part of ADP):
+
+| Method | Path | Purpose |
+|---|---|---|
+| `GET` | `/api/panel/summary` | Counts, deployment facts, RegistryCard |
+| `GET` | `/api/panel/agents` | Agents with local task counts |
+| `GET` | `/api/panel/agents/{id}` | Record + interfaces + recent tasks |
+| `POST` | `/api/panel/agents/{id}/refresh` | Probe this agent now |
+| `DELETE` | `/api/panel/agents/{id}` | Unregister with `{"token": …}` |
+| `POST` | `/api/panel/agents/{id}/tasks` | Submit `{"text": …}` over A2A |
+| `GET` | `/api/panel/tasks` | Local task ledger (`agentId`, `state`, `q`, `limit`, `cursor`) |
+| `GET` | `/api/panel/tasks/{id}` | Task + event log + raw payloads |
+| `POST` | `/api/panel/tasks/{id}/refresh` | `tasks/get` against the agent |
+| `POST` | `/api/panel/tasks/{id}/cancel` | `tasks/cancel` against the agent |
+| `POST` | `/api/panel/tasks/{id}/messages` | Follow-up message in the same task/context |
+| `DELETE` | `/api/panel/tasks/{id}` | Forget the task locally |
+
+## Two A2A generations
+
+Agents in the wild speak two dialects. The client reads the card, picks one, and — if the
+agent answers *method not found* or *invalid params* — retries once with the other:
+
+| Card shape | Methods | Message shape |
+|---|---|---|
+| `url` + `protocolVersion: 0.x` | `message/send`, `tasks/get`, `tasks/cancel` | `role: "user"`, parts tagged `kind: "text"` |
+| `supportedInterfaces` / `protocolVersion: 1.x` | `SendMessage`, `GetTask`, `CancelTask` | `role: "ROLE_USER"`, parts as `{text}` |
+
+Both responses are normalized to the same internal view, including task states such as
+`TASK_STATE_INPUT_REQUIRED` → `input-required`.
+
+## Configuration
+
+Every setting has an environment variable (`OACP_*`) and most have a flag. Precedence is
+default < environment < flag.
+
+| Flag | Variable | Default | Meaning |
+|---|---|---|---|
+| `--db` | `OACP_DB_PATH` | `oacp.db` | SQLite file |
+| `--public-url` | `OACP_PUBLIC_URL` | `http://127.0.0.1:8000` | External base URL, advertised in the RegistryCard |
+| `--name` | `OACP_DISPLAY_NAME` | `Open Agent Control Panel` | Registry display name |
+| `--contact` | `OACP_CONTACT` | — | Contact line in the RegistryCard |
+| — | `OACP_SPEC_URL` | `urn:adp:core:1.0.0` | Identifier of the protocol spec |
+| `--panel-token` | `OACP_PANEL_TOKEN` | — | Require this token on `/api/panel/*` |
+| `--card-validation` | `OACP_CARD_VALIDATION` | `relaxed` | `strict` = ADP §6.3 exactly; `relaxed` also accepts A2A 0.3 cards |
+| `--probe-interval` | `OACP_PROBE_INTERVAL` | `300` | Seconds between probes for healthy agents |
+| — | `OACP_DOWN_PROBE_INTERVAL` | `60` | Seconds between probes for `down` agents |
+| `--no-probe` | `OACP_PROBE_ENABLED` | `true` | Disable the background probe loop |
+| — | `OACP_PROBE_CONCURRENCY` | `4` | Concurrent probes |
+| — | `OACP_MAX_CARD_BYTES` | `1048576` | Card size cap |
+| — | `OACP_MAX_AGENTS_PER_DOMAIN` | `100` | Per-host entry cap |
+| — | `OACP_REGISTER_PER_HOUR` | `20` | Per-IP registration attempts per hour |
+| `--allow-insecure-cards` | `OACP_ALLOW_INSECURE_CARDS` | `false` | **Dev only:** accept http/private card URLs |
+| `--allow-private-agents` | `OACP_ALLOW_PRIVATE_AGENTS` | `false` | **Dev only:** call private A2A endpoints |
+| `--a2a-timeout` | `OACP_A2A_TIMEOUT` | `60` | A2A request timeout in seconds |
+| `--host` / `--port` | — | `127.0.0.1` / `8000` | Bind address |
+
+## Security model
+
+The panel makes requests to URLs chosen by strangers, so the outbound path is the product.
+
+* **https only** for cards; userinfo and fragments are rejected.
+* **DNS pinning** — the resolved address is validated and then pinned into the connection
+  (`Host` header + TLS SNI preserved), so a name cannot resolve to one address at check time
+  and another at connect time. Mixed public/private answers are refused outright.
+* **Manual redirects**, at most three hops, each re-validated from scratch.
+* **Streaming body cap**, connect/total timeouts, no cookies, no caller credentials,
+  TLS verification that cannot be switched off, and `trust_env=False` so environment proxies
+  cannot silently take over DNS and connection establishment.
+* **A2A calls use the same guard**, which matters because a card can point anywhere.
+* **Manage tokens are stored hashed**; the plaintext exists only in the registration response
+  and in the browser that performed it.
+* **Optional panel token** protects `/api/panel/*` while leaving the registry open enough for
+  agents to register. That split is intentional: the protocol is public, the control plane is
+  yours.
+
+Deploy behind TLS (a reverse proxy is fine) and set `--public-url` to the external URL so the
+RegistryCard points somewhere reachable.
+
+## Development
+
+```bash
+python -m venv .venv && . .venv/bin/activate   # Windows: .venv\Scripts\activate
+pip install -e ".[dev]"
+python -m pytest -q
+```
+
+Layout:
+
+```
+src/oacp/
+  adp/        spec implementation: jcs, card checks, guarded fetcher, registry, routes, probe loop
+  a2a/        JSON-RPC client with the two-dialect fallback
+  tasks.py    local task ledger and A2A interactions
+  api.py      panel API
+  app.py      application factory, static UI, error mapping
+  cli.py      `oacp serve`
+  web/        index.html, styles.css, app.js
+examples/     a tiny echo agent for local demos
+tests/        pytest, with a mock A2A transport and a fake card fetcher
+```
+
+The test suite never touches the network: registration tests inject a fake fetcher and A2A
+tests inject an `httpx.MockTransport`.
+
+## Limitations
+
+* No streaming (`message/stream`, `tasks/resubscribe`); tasks are followed by polling.
+* Tasks are refreshed when you ask, not continuously.
+* Single process, single SQLite file: this is a control plane, not a cluster service.
+* No push notifications, no authentication schemes beyond A2A's own endpoint requirements.
+
+## Links
+
+* Source: <https://github.com/YY-Yifei/open-agent-control-panel>
+* Package: <https://pypi.org/project/open-agent-control-panel/>
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE).