acp-runtime 0.1.0

package/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.

package/README.md

@@ -0,0 +1,111 @@
+## ACP — Agent Communication Protocol
+ACP (Agent Communication Protocol) is a secure, identity-driven protocol for autonomous systems to communicate, collaborate, and coordinate across environments.
+Unlike traditional API integrations or message brokers, ACP is designed for AI agents operating in dynamic, distributed ecosystems.
+This project is not related to other packages using the acronym "ACP"
+
+**HTTP is for services. ACP is for agents.**
+
+## What is ACP?
+
+ACP provides:
+- Identity-first communication between agents
+- Signed and optionally encrypted message envelopes
+- Transport independence (HTTP, AMQP, MQTT)
+- Relay-based routing across network boundaries
+- Capability-driven interaction patterns
+
+This enables agents to discover each other, exchange messages, and collaborate without tight coupling.
+
+## What ACP Is Not
+
+- Not a message broker.
+- Not a JSON schema format.
+- Not a framework-specific tool protocol.
+
+## Why ACP?
+Modern systems are evolving from services into autonomous agents.
+Current approaches (REST APIs, webhooks, point-to-point messaging) lead to:
+- brittle integrations
+- hidden coupling
+- limited interoperability
+- lack of governance
+
+ACP introduces a protocol layer for agent communication, similar to how HTTP enabled the web.
+
+## When to Use ACP
+
+Use ACP when:
+
+- autonomous agents need to communicate across teams, runtimes, or network boundaries
+- identity and message verification are required at the protocol level
+- you want one protocol across direct and relay delivery paths
+
+ACP may be unnecessary when:
+
+- one application calls one service with stable, tightly controlled APIs
+- plain HTTP/REST already solves the integration with low coordination overhead
+
+## ACP vs Typical Approaches
+
+| Approach | Good fit | Gaps for autonomous agent communication |
+| --- | --- | --- |
+| REST APIs | stable service-to-service calls | endpoint coupling and custom identity/discovery conventions |
+| Webhooks | event callbacks | delivery and trust rules vary by implementation |
+| Message brokers | high-throughput internal messaging | broker-specific semantics, no shared agent protocol layer |
+| Agent tool protocols | tool invocation inside one framework | often framework-scoped, not cross-runtime protocol contracts |
+| ACP | cross-agent protocol with identity + secure envelopes | adds protocol concepts not needed for trivial single-service cases |
+
+## SDK Installation Parity
+
+Status labels used in this repo:
+- `Published`
+- `Available from repo`
+- `Coming`
+
+| SDK | Status                |
+| Python (`acp-runtime`) | `Published`|
+| TypeScript (`acp-runtime`) | `Published`|
+| Rust (`acp`) | `Available from repo`|
+| Go (`github.com/acp/sdk-go`) | `Available from repo`|
+| Java (`io.acp:acp-sdk`) | `Available from repo` |
+| Mojo wrapper (`acp-sdk-mojo`) | `Available from repo` |
+
+No SDK in this repository snapshot is currently labeled `Coming`.
+
+## Repo Structure
+
+- `getting-started/`: verified local ping flow
+- `examples/`: runnable demos (`hello_world_agent.py`, one-to-one, one-to-many, capabilities)
+- `sdks/`: language SDK implementations
+- `cli/`: ACP CLI (`acp`)
+- `relay-dev/`: developer relay for local/test routing
+
+## Open Source Scope
+
+This repository is for learning, local development, and interoperability testing.
+
+---
+## Install from repo
+
+```bash
+cd sdks/typescript
+npm install
+npm run build
+```
+
+## Validate
+
+```bash
+npm run lint
+npm run test
+```
+
+## First-run reference
+
+For the fastest protocol walkthrough, run:
+
+```bash
+./getting-started/quickstart_ping.sh
+```
+
+Then use this SDK for cross-language interoperability tests.

package/dist/agent.d.ts

@@ -0,0 +1,67 @@
+import { AgentCapabilities } from "./capabilities.js";
+import { DiscoveryClient } from "./discovery.js";
+import { AgentIdentity } from "./identity.js";
+import { JsonMap } from "./jsonSupport.js";
+import { AcpMessage, DeliveryMode, DeliveryState, Envelope, MessageClass, SendResult } from "./messages.js";
+import { AmqpTransportClient } from "./amqpTransport.js";
+import { MqttTransportClient } from "./mqttTransport.js";
+import { AcpAgentOptions } from "./options.js";
+import { KeyProviderInfo } from "./keyProvider.js";
+import { TransportClient } from "./transport.js";
+export interface InboundResult {
+    state: DeliveryState;
+    reason_code?: string;
+    detail?: string;
+    decrypted_payload?: JsonMap;
+    response_message?: JsonMap;
+}
+export interface DecryptedMessage {
+    message: AcpMessage;
+    payload: JsonMap;
+}
+export interface CapabilityRequestResult {
+    result: SendResult;
+    capabilities?: JsonMap;
+}
+type InboundHandler = (payload: JsonMap, envelope: Envelope) => JsonMap | undefined;
+export declare class AcpAgent {
+    identity: AgentIdentity;
+    identity_document: JsonMap;
+    discovery: DiscoveryClient;
+    transport: TransportClient;
+    amqp_transport: AmqpTransportClient | undefined;
+    mqtt_transport: MqttTransportClient | undefined;
+    capabilities: AgentCapabilities;
+    storage_dir: string;
+    trust_profile: string;
+    relay_url: string;
+    default_delivery_mode: DeliveryMode;
+    key_provider_info: KeyProviderInfo;
+    private readonly dedup;
+    private delivery_states;
+    private constructor();
+    static loadOrCreate(agentId: string, optionsInput?: Partial<AcpAgentOptions>): Promise<AcpAgent>;
+    private static resolveKeyProvider;
+    agentId(): string;
+    getDeliveryStates(): Record<string, Record<string, string>>;
+    buildWellKnownDocument(baseUrl?: string, identityDocumentUrl?: string): JsonMap;
+    registerIdentityDocument(identityDocument: JsonMap): void;
+    resolveWellKnown(baseUrl: string, expectedAgentId?: string): Promise<JsonMap>;
+    private resolveRecipients;
+    private chooseDeliveryChannel;
+    private buildMessage;
+    private deliverDirect;
+    private deliverRelay;
+    private deliverAmqp;
+    private deliverMqtt;
+    private syncDeliveryStates;
+    send(recipients: string[], payload: JsonMap, context?: string, messageClass?: MessageClass, expiresInSeconds?: number, correlationId?: string, inReplyTo?: string, deliveryMode?: DeliveryMode): Promise<SendResult>;
+    sendBasic(recipients: string[], payload: JsonMap, context?: string): Promise<SendResult>;
+    private resolveSenderIdentityDocument;
+    private validateEnvelopeForInbound;
+    private createResponseMessage;
+    decryptMessageForSelf(rawMessage: JsonMap): Promise<DecryptedMessage>;
+    receive(rawMessage: JsonMap, handler?: InboundHandler): Promise<InboundResult>;
+    requestCapabilities(recipient: string): Promise<CapabilityRequestResult>;
+}
+export {};